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

[dev2] Configuration files: global.conf #2955

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
3 changes: 2 additions & 1 deletion reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ Reference
.. toctree::
:maxdepth: 2
:titlesonly:

reference/commands
reference/conanfile
reference/conanfile_txt
reference/tools
reference/config_files
reference/extensions
2 changes: 1 addition & 1 deletion reference/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Commands
========

This section describe the Conan built-in commmands, like ``conan install`` or ``conan search``.
This section describe the Conan built-in commands, like ``conan install`` or ``conan search``.

It is also possible to create user custom commands, visit :ref:`custom commands reference <reference_commands_custom_commands>`
and these :ref:`custom command examples <examples_extensions_custom_commands>`
Expand Down
2 changes: 2 additions & 0 deletions reference/commands/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ conan config home
$ conan config home


.. _reference_commands_conan_config_install:

conan config install
--------------------

Expand Down
2 changes: 2 additions & 0 deletions reference/conanfile/attributes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,8 @@ tool_requires
conanfile.py method to learn a more flexible way to add them.


.. _reference_conanfile_attributes_build_requires:

build_requires
--------------

Expand Down
12 changes: 12 additions & 0 deletions reference/config_files.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _reference_config_files:

Configuration files
===================

These are the most important configuration files, used to customize conan.


.. toctree::
:maxdepth: 2

config_files/global_conf
383 changes: 383 additions & 0 deletions reference/config_files/global_conf.rst

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions reference/tools/gnu/pkgconfig.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,5 @@ Reference
conf
^^^^

This helper will listen to ``tools.gnu:pkg_config`` `global_conf` to define the ``pkg_config`` executable name or full path.
It will by default it is ``pkg-config``.
This helper will listen to ``tools.gnu:pkg_config`` from the :ref:`reference_config_files_global_conf` to define
the ``pkg_config`` executable name or full path. It will by default it is ``pkg-config``.
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. _tutorial_other_tool_requires_packages:


Tool requires packages
======================

Expand Down