Automatic deploy (build number 563)

2.0/_sources/reference/config_files.rst.txt

@@ -15,3 +15,4 @@ These are the most important configuration files, used to customize conan.
     config_files/remotes
     config_files/source_credentials
     config_files/credentials
+    config_files/conanrc

2.0/_sources/reference/config_files/conanrc.rst.txt

@@ -0,0 +1,55 @@
+.. _reference_config_files_conanrc:
+
+.conanrc
+========
+
+.. warning::
+
+  This feature is in **preview**.
+  See :ref:`the Conan stability<stability>` section for more information.
+
+The **.conanrc** file can be placed in the folder where you are running Conan or any
+parent folder. This file is used to set up the Conan user home directory by defining the
+`conan_home` value. This value will take precedence over the :ref:`CONAN_HOME
+<reference_environment_variables_conan_home>` environment variable in case it's also
+defined. Below are some examples of how you can define the Conan user home in the
+**.conanrc** file:
+
+Set the Conan home to an absolute folder:
+
+.. code-block:: bash
+
+    # accepts comments
+    conan_home=/absolute/folder
+
+Set the Conan home to a relative folder inside the current folder:
+
+.. code-block:: bash
+
+    conan_home=./relative/folder/inside/current/folder
+
+Set the Conan home to a relative folder outside the current folder:
+
+.. code-block:: bash
+
+    conan_home=../relative/folder/outside/current/folder
+
+Set the Conan home to a path containing the `~` symbol, which will be expanded to the system's user home:
+
+.. code-block:: bash
+
+    conan_home=~/use/the/user/home/to/expand/it
+
+Be aware that the **.conanrc** file is searched for in all parent folders. For
+example, in this structure:
+
+.. code-block:: bash
+
+    .
+    .conanrc
+    |-- project1
+    |-- project2
+
+
+If you are running from the folder `project1`, the parent folders are traversed recursively
+until a **.conanrc** file is found, in case it exists.

2.0/_sources/reference/environment.rst.txt

@@ -7,6 +7,7 @@ These are very few environment variables that can be used to configure some of t
 These variables are the exception, for customization and configuration control, Conan uses the 
 :ref:`global.conf configuration<reference_config_files_global_conf>` and the :ref:`profile [conf] section<reference_config_files_profiles>`
 
+.. _reference_environment_variables_conan_home:
 
 CONAN_HOME
 ----------

2.0/reference.html

@@ -246,6 +246,7 @@
 <li class="toctree-l2"><a class="reference internal" href="reference/config_files/remotes.html">remotes.json</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference/config_files/source_credentials.html">source_credentials.json</a></li>
 <li class="toctree-l2"><a class="reference internal" href="reference/config_files/credentials.html">credentials.json</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/config_files/conanrc.html">.conanrc</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="reference/extensions.html">Extensions</a><ul>

2.0/reference/config_files.html

@@ -128,6 +128,7 @@
 <li class="toctree-l3"><a class="reference internal" href="config_files/remotes.html">remotes.json</a></li>
 <li class="toctree-l3"><a class="reference internal" href="config_files/source_credentials.html">source_credentials.json</a></li>
 <li class="toctree-l3"><a class="reference internal" href="config_files/credentials.html">credentials.json</a></li>
+<li class="toctree-l3"><a class="reference internal" href="config_files/conanrc.html">.conanrc</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="extensions.html">Extensions</a></li>
@@ -257,6 +258,7 @@
 <li class="toctree-l1"><a class="reference internal" href="config_files/remotes.html">remotes.json</a></li>
 <li class="toctree-l1"><a class="reference internal" href="config_files/source_credentials.html">source_credentials.json</a></li>
 <li class="toctree-l1"><a class="reference internal" href="config_files/credentials.html">credentials.json</a></li>
+<li class="toctree-l1"><a class="reference internal" href="config_files/conanrc.html">.conanrc</a></li>
 </ul>
 </div>
 </div>