Add description to info output (#1627)

* Add description to info output Signed-off-by: Uilian Ries <uilianries@gmail.com> * Add description to info output Signed-off-by: Uilian Ries <uilianries@gmail.com> * Update conan info output Signed-off-by: Uilian Ries <uilianries@gmail.com>
conan-io · Mar 25, 2020 · 366a36b · 366a36b
1 parent 2ab4022
commit 366a36b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/getting_started.rst b/getting_started.rst
@@ -291,6 +291,7 @@ To inspect all your current project's dependencies use the :command:`conan info`
         URL: https://github.com/conan-io/conan-center-index
         Homepage: https://github.com/openssl/openssl
         License: OpenSSL
+        Description: A toolkit for the Transport Layer Security (TLS) and Secure Sockets Layer (SSL) protocols
         Topics: conan, openssl, ssl, tls, encryption, security
         Recipe: Cache
         Binary: Cache
@@ -307,6 +308,7 @@ To inspect all your current project's dependencies use the :command:`conan info`
         URL: https://github.com/conan-io/conan-center-index
         Homepage: https://pocoproject.org
         License: BSL-1.0
+        Description: Modern, powerful open source C++ class libraries for building network- and internet-based applications that run on desktop, server, mobile and embedded systems.
         Topics: conan, poco, building, networking, server, mobile, embedded
         Recipe: Cache
         Binary: Cache
@@ -323,6 +325,7 @@ To inspect all your current project's dependencies use the :command:`conan info`
         URL: https://github.com/conan-io/conan-center-index
         Homepage: https://zlib.net
         License: Zlib
+        Description: A Massively Spiffy Yet Delicately Unobtrusive Compression Library (Also Free, Not to Mention Unencumbered by Patents)
         Recipe: Cache
         Binary: Cache
         Binary remote: conan-center

diff --git a/reference/commands/consumer/info.rst b/reference/commands/consumer/info.rst
@@ -49,8 +49,8 @@ your local cache.
                             written
       -n ONLY, --only ONLY  Show only the specified fields: "id", "build_id",
                             "remote", "url", "license", "requires", "update",
-                            "required", "date", "author", "None". '--paths'
-                            information can also be filtered with options
+                            "required", "date", "author", "description", "None". '
+                            --paths' information can also be filtered with options
                             "export_folder", "build_folder", "package_folder",
                             "source_folder". Use '--only None' to show only
                             references.
@@ -101,6 +101,7 @@ The output will look like:
      Remote: None
      URL: http://...
      License: MIT
+     Description: A common dependency
      Updates: Version not checked
      Creation date: 2017-10-31 14:45:34
      Required by:
@@ -112,6 +113,7 @@ The output will look like:
      Remote: None
      URL: http://...
      License: MIT
+     Description: Hello World!
      Updates: Version not checked
      Required by:
         Project
@@ -228,6 +230,7 @@ The output will look like:
         package_folder: /home/conan/.conan/data/foobar/1.0.0/user/channel/package/6af9cc7cb931c5ad942174fd7838eb655717c709
         Remote: None
         License: MIT
+        Description: Foobar project
         Author: Dummy
         Topics: None
         Recipe: Cache

diff --git a/reference/commands/output/info.rst b/reference/commands/output/info.rst
@@ -86,6 +86,7 @@ contain a list with the information for each of the nodes.
             "license":[  
                 "MIT"
             ],
+            "description": "project A",
             "recipe":"No remote",
             "binary":"Missing",
             "creation_date":"2019-01-29 17:22:41",
@@ -104,6 +105,7 @@ contain a list with the information for each of the nodes.
             "license":[  
                 "MIT"
             ],
+            "description": "project C",
             "recipe":"No remote",
             "binary":"Missing",
             "creation_date":"2019-01-29 17:22:41",