Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Add global.conf description section #3561

Merged
merged 3 commits into from
Feb 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions reference/config_files/global_conf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,34 @@ To list all the possible configurations available, run :command:`conan config li

.. include:: ../../common/config_list.inc

Description of configurations
+++++++++++++++++++++++++++++

core.cache:storage_path
^^^^^^^^^^^^^^^^^^^^^^^

Absolute path to a folder where the Conan packages and the database of the packages will be stored.
This folder will be the heaviest Conan storage folder, as it stores the binary packages dowloaded or created.

.. code-block:: text
:caption: *global.conf*

core.cache.storage_path = C:\Users\danielm\my_conan_storage_folder

**Default value:** ``<CONAN_HOME>/p``

core.download:download_cache
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Absolute path to a folder where the Conan packages will be stored *compressed*.
This is useful to avoid recurrent downloads of the same packages, especially in CI.

.. code-block:: text
:caption: *global.conf*

core.cache.download_cache = C:\Users\danielm\my_download_cache

**Default value:** Not defined.


User/Tools configurations
Expand Down Expand Up @@ -183,7 +211,7 @@ Networking confs
.. _reference_config_files_global_conf_ssl_certificates:

Configuration of client certificates
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
++++++++++++++++++++++++++++++++++++

Conan supports client TLS certificates. You can configure the path to your existing *Cacert* file and/or your client
certificate (and the key) using the following configuration variables:
Expand Down Expand Up @@ -218,7 +246,7 @@ UX confs
.. _reference_config_files_global_conf_skip_warnings:

Skip warnings
~~~~~~~~~~~~~
+++++++++++++

There are several warnings that Conan outputs in certain cases which can be omitted via the ``core:skip_warnings`` conf,
by adding the warning tag to its value.
Expand Down