add config home --json docs (conan-io#1464)

* add config home --json docs * Update reference/commands/output/config.rst Co-Authored-By: Javier G. Sogo <[email protected]>
Dattax · Oct 28, 2019 · 88d42ac · 88d42ac
1 parent e6258c4
commit 88d42ac
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 2 deletions.
diff --git a/reference/commands.rst b/reference/commands.rst
@@ -72,8 +72,8 @@ Other useful commands:
 
 
 
-Output
-------
+JSON Output
+-----------
 
 JSON documents generated by the commands:
 
@@ -85,6 +85,7 @@ JSON documents generated by the commands:
   commands/output/upload.rst
   commands/output/user.rst
   commands/output/info.rst
+  commands/output/config.rst
 
 Return codes
 ------------

diff --git a/reference/commands/output/config.rst b/reference/commands/output/config.rst
@@ -0,0 +1,26 @@
+
+.. _config_json:
+
+
+Config output
+-------------
+
+.. warning::
+
+    This is an **experimental** feature subject to breaking changes in future releases.
+
+The :command:`conan config home` provides a ``--json`` parameter to generate
+a file containing the information of the conan home directory.
+
+..  code-block:: bash
+
+    $ conan config home --json home.json
+
+It will create a JSON file like:
+
+..  code-block:: json
+    :caption: home.json
+
+    {
+        "home": "/path/to/conan/home"
+    }