Skip to content

Commit

Permalink
Update conan config install with new changes (#975)
Browse files Browse the repository at this point in the history
* Update conan config install with new changes

* small fixes

* example of --args

* small fixes
  • Loading branch information
danimtb authored and memsharded committed Dec 18, 2018
1 parent fcbee01 commit 025bbe5
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 14 deletions.
2 changes: 1 addition & 1 deletion mastering/sharing_settings_and_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ You can use the :command:`conan config install`.
If you want to try this feature without affecting to your current configuration you can declare the ``CONAN_USER_HOME`` environment variable
and point to a different directory.

Read more in the section :ref:`reference/commands/conan config install<conan_config_install>`.
Read more in the section :ref:`conan_config_install`.
19 changes: 10 additions & 9 deletions reference/commands/consumer/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ conan config install
The ``config install`` is intended to share the Conan client configuration. For example, in a company or organization,
is important to have common ``settings.yml``, ``profiles``, etc.

It can get its configuration files from a local or remote zip file, or a local directory. It then installs the files
in the local Conan configuration.
It can get its configuration files from a local or remote zip file, from a local directory or from a git repository. It then installs the
files in the local Conan configuration.

The configuration may contain all or a subset of the allowed configuration files. Only the files that are present will be
replaced. The only exception is the **conan.conf** file for which only the variables declared will be installed,
Expand All @@ -61,8 +61,7 @@ leaving the other variables unchanged.
This means for example that **profiles** and **hooks** files will be overwritten if already present, but no profile or
hook file that the user has in the local machine will be deleted.

All the configuration files will be copied to the conan home directory.
These are the special files and the rules applied to merge them:
All the configuration files will be copied to the Conan home directory. These are the special files and the rules applied to merge them:

+--------------------------------+----------------------------------------------------------------------+
| File | How it is applied |
Expand Down Expand Up @@ -91,8 +90,9 @@ definitions part of the *registry.txt* file uses the format required for *remote
provides a helpful starting point when writing a *remotes.txt* to be packaged in a Conan
client configuration.

The specified URL will be stored in the ``general.config_install`` variable of the ``conan.conf`` file,
so following calls to :command:`conan config install` command doesn't need to specify the URL.
The specified URL or path, the arguments used (if any) and the source type (from git, from dir, from zip file or from URL) will be stored in the
``general.config_install`` variable of the ``conan.conf`` file, so as following calls to :command:`conan config install` command doesn't
need to specify them.

**Examples**:

Expand All @@ -104,11 +104,11 @@ so following calls to :command:`conan config install` command doesn't need to sp
Conan config command stores the specified URL in the conan.conf ``general.config_install`` variable.

- Install the configuration from a Git repository:
- Install the configuration from a Git repository with submodules:

.. code-block:: bash
$ conan config install http://github.com/user/conan_config/.git
$ conan config install http://github.com/user/conan_config/.git --args "--recursive"
You can also force the git download by using :command:`--type git` (in case it is not deduced from the URL automatically):

Expand All @@ -122,7 +122,8 @@ so following calls to :command:`conan config install` command doesn't need to sp
$ conan config install http://url/to/some/config.zip --verify-ssl=False
This will disable the SSL check of the certificate. This option is defaulted to ``True``.
This will disable the SSL check of the certificate. This option is defaulted to ``True`` and it is not stored in *conan.conf*, so
following calls to this command will need to specify it again.

- Refresh the configuration again:

Expand Down
2 changes: 1 addition & 1 deletion reference/commands/misc/remote.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Manages the remote list and the package recipes associated to a remote.
conan-center: https://conan.bintray.com [Verify SSL: True]
local: http://localhost:9300 [Verify SSL: True]
- List remotes in a format valid for *remotes.txt* (``conan config install``):
- List remotes in a format valid for *remotes.txt* (:command:`conan config install`):

.. code-block:: bash
Expand Down
4 changes: 2 additions & 2 deletions uploading_packages/remotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ Conan Community
.. note::

If you are working in a team, you probably want to use the same remotes everywhere: developer machines, CI. The ``conan config install``
command can automatically define the remotes in a conan client, as well as other resources as profiles. Have a look at the
:ref:`conan config install<conan_config_install>` command.
command can automatically define the remotes in a Conan client, as well as other resources as profiles. Have a look at the
:ref:`conan_config_install` command.


.. _`conan-center`: https://bintray.com/conan/conan-center
Expand Down
2 changes: 1 addition & 1 deletion using_packages/using_profiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,6 @@ To install dependencies using this new profile, we would use:
.. seealso::

Read more about :ref:`profiles` for full reference. There is a conan command, :ref:`conan_profile`,
Read more about :ref:`profiles` for full reference. There is a Conan command, :ref:`conan_profile`,
that can help inspecting and managing profiles. Profiles can be also shared and installed with the
:ref:`conan_config_install` command.

0 comments on commit 025bbe5

Please sign in to comment.