Skip to content

Commit

Permalink
docs for default profiles conf (#2213)
Browse files Browse the repository at this point in the history
  • Loading branch information
memsharded committed Sep 6, 2021
1 parent aac1a11 commit 7940cd7
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 21 deletions.
50 changes: 29 additions & 21 deletions reference/config_files/global_conf.rst
Expand Up @@ -37,30 +37,38 @@ have priority over globally defined ones in *global.conf*, and can be defined as
tools.ninja:jobs=30
tools.gnu.make:jobs=40
Existing configurations:

- ``tools.microsoft.msbuild:verbosity`` allows defining a value from ``"Quiet", "Minimal", "Normal",
"Detailed", "Diagnostic"`` for build using the
MSBuild system, it could be with the ``tools.microsoft.MSBuild`` or with the ``tools.cmake.CMake``
helpers.

- ``tools.microsoft.msbuild:max_cpu_count`` argument for the ``/m`` (``/maxCpuCount``) when running
``MSBuild`` standalone or via CMake (overrides the general ``tools.build:processes``).

- ``tools.microsoft.msbuild:vs_version`` defines the compiler version when using using the new ``msvc`` compiler.

- ``tools.build:processes``: number of processes to use for every build-helper.

- ``tools.build:skip_test``: CMake and Meson helper should skip ``test()``

- ``tools.ninja:jobs`` argument for the ``--jobs`` parameter when running Ninja generator via CMake
or Meson. (overrides the general ``tools.build:processes``).

- ``tools.gnu.make:jobs``: argument for the ``--jobs`` parameter when running ``make``
(overrides the general ``tools.build:processes``).
To list all possible configurations available, run :command:`conan config list`.

- core:required_conan_version: Raise if current version does not match the defined range.
- core.package_id:msvc_visual_incompatible: Allows opting-out the fallback from the new msvc compiler to the Visual Studio compiler existing binaries
- core:default_profile: Defines the default host profile ('default' by default)
- core:default_build_profile: Defines the default build profile (None by default)
- tools.android:ndk_path: Argument for the CMAKE_ANDROID_NDK
- tools.build:skip_test: Do not execute CMake.test() and Meson.test() when enabled
- tools.build:processes: Default jobs number
- tools.cmake.cmaketoolchain:generator: User defined CMake generator to use instead of default
- tools.cmake.cmaketoolchain:msvc_parallel_compile: Argument for the /MP when running msvc
- tools.cmake.cmaketoolchain:find_package_prefer_config: Argument for the CMAKE_FIND_PACKAGE_PREFER_CONFIG
- tools.cmake.cmaketoolchain:toolchain_file: Use other existing file rather than conan_toolchain.cmake one
- tools.cmake.cmaketoolchain:user_toolchain: Inject existing user toolchain at the beginning of conan_toolchain.cmake
- tools.cmake.cmaketoolchain:system_name: Define CMAKE_SYSTEM_NAME in CMakeToolchain
- tools.cmake.cmaketoolchain:system_version: Define CMAKE_SYSTEM_VERSION in CMakeToolchain
- tools.cmake.cmaketoolchain:system_processor: Define CMAKE_SYSTEM_PROCESSOR in CMakeToolchain
- tools.env.virtualenv:auto_use: Automatically activate virtualenv file generation
- tools.files.download:retry: Number of retries in case of failure when downloading
- tools.files.download:retry_wait: Seconds to wait between download attempts
- tools.gnu:make_program: Indicate path to make program
- tools.gnu.make:jobs: Argument for the -j parameter when running Make generator
- tools.google.bazel:config: Define Bazel config file
- tools.google.bazel:bazelrc_path: Defines Bazel rc-path
- tools.microsoft.msbuild:verbosity: Verbosity level for MSBuild: 'Quiet', 'Minimal', 'Normal', 'Detailed', 'Diagnostic'
- tools.microsoft.msbuild:max_cpu_count: Argument for the /m (/maxCpuCount) when running MSBuild
- tools.microsoft.msbuild:vs_version: Defines the IDE version when using the new msvc compiler
- tools.microsoft.msbuilddeps:exclude_code_analysis: Suppress MSBuild code analysis for patterns
- tools.microsoft.msbuildtoolchain:compile_options: Dictionary with MSBuild compiler options
- tools.ninja:jobs: Argument for the --jobs parameter when running Ninja generator


Configuration from build_requires
-----------------------------------
Expand Down
11 changes: 11 additions & 0 deletions reference/profiles.rst
Expand Up @@ -287,6 +287,17 @@ extremly useful:
* :ref:`create_installer_packages`
* :ref:`cross_building`

The default build profile in Conan 1.X is not defined by default, and needs to be specified in command line.
However, it is also possible to define a default one in ``global.conf`` configuration file with:

.. code-block:: text
:caption: *global.conf*
core:default_build_profile=default
core:default_profile=linux_armv8
The default host profile can be defaulted as well using this configuration method.


Profile templates
-----------------
Expand Down

0 comments on commit 7940cd7

Please sign in to comment.