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

Add verbosity docs #3277

Merged
merged 1 commit into from
Jun 20, 2023
Merged
Show file tree
Hide file tree
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
5 changes: 4 additions & 1 deletion reference/commands/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ Displays all the Conan built-in configurations. There are 2 groups:
.. code-block:: text

$ conan config list

core.cache:storage_path: Absolute path where the packages and database are stored
core.download:download_cache: Define path to a file download cache
core.download:parallel: Number of concurrent threads to download packages
Expand All @@ -204,6 +205,7 @@ Displays all the Conan built-in configurations. There are 2 groups:
core.package_id:default_unknown_mode: By default, 'semver_mode'
core.sources:download_cache: Folder to store the sources backup
core.sources:download_urls: List of URLs to download backup sources from
core.sources:exclude_urls: URLs which will not be backed up
core.sources:upload_url: Remote URL to upload backup sources to
core.upload:retry: Number of retries in case of failure when uploading to Conan server
core.upload:retry_wait: Seconds to wait between upload attempts to Conan server
Expand Down Expand Up @@ -232,7 +234,7 @@ Displays all the Conan built-in configurations. There are 2 groups:
tools.build:sharedlinkflags: List of extra flags used by CMakeToolchain for CMAKE_SHARED_LINKER_FLAGS_INIT variable
tools.build:skip_test: Do not execute CMake.test() and Meson.test() when enabled
tools.build:sysroot: Pass the --sysroot=<tools.build:sysroot> flag if available. (None by default)
tools.build:verbosity: Verbosity of MSBuild and XCodeBuild build systems. Possible values are 'quiet', 'error', 'warning', 'notice', 'status', 'verbose', 'normal', 'debug', 'v', 'trace' and 'vv'
tools.build:verbosity: Verbosity of build systems if set. Possible values are 'quiet' and 'verbose'
tools.cmake.cmake_layout:build_folder_vars: Settings and Options that will produce a different build folder and different CMake presets names
tools.cmake.cmaketoolchain:find_package_prefer_config: Argument for the CMAKE_FIND_PACKAGE_PREFER_CONFIG
tools.cmake.cmaketoolchain:generator: User defined CMake generator to use instead of default
Expand All @@ -243,6 +245,7 @@ Displays all the Conan built-in configurations. There are 2 groups:
tools.cmake.cmaketoolchain:toolset_arch: Toolset architecture to be used as part of CMAKE_GENERATOR_TOOLSET in CMakeToolchain
tools.cmake.cmaketoolchain:user_toolchain: Inject existing user toolchains at the beginning of conan_toolchain.cmake
tools.cmake:cmake_program: Path to CMake executable
tools.compilation:verbosity: Verbosity of compilation tools if set. Possible values are 'quiet' and 'verbose'
tools.env.virtualenv:powershell: If it is set to True it will generate powershell launchers if os=Windows
tools.files.download:retry: Number of retries in case of failure when downloading
tools.files.download:retry_wait: Seconds to wait between download attempts
Expand Down
2 changes: 1 addition & 1 deletion reference/conanfile/methods/package_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ package packaging the AndroidNDK could do:

def package_info(self):
# Setting values
self.conf_info.define("tools.build:verbosity", "debug")
self.conf_info.define("tools.build:verbosity", "verbose")
self.conf_info.define("tools.system.package_manager:sudo", True)
self.conf_info.define("tools.microsoft.msbuild:max_cpu_count", 2)
self.conf_info.define("user.myconf.build:ldflags", ["--flag1", "--flag2"])
Expand Down
17 changes: 13 additions & 4 deletions reference/config_files/global_conf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,20 @@ To list all the possible configurations available, run :command:`conan config li
core.package_id:default_non_embed_mode: By default, 'minor_mode'
core.package_id:default_python_mode: By default, 'minor_mode'
core.package_id:default_unknown_mode: By default, 'semver_mode'
core.sources:download_cache: Folder to store the sources backup
core.sources:download_urls: List of URLs to download backup sources from
core.sources:exclude_urls: URLs which will not be backed up
core.sources:upload_url: Remote URL to upload backup sources to
core.upload:retry: Number of retries in case of failure when uploading to Conan server
core.upload:retry_wait: Seconds to wait between upload attempts to Conan server
core.version_ranges:resolve_prereleases: Whether version ranges can resolve to pre-releases or not
core:allow_uppercase_pkg_names: Temporarily (will be removed in 2.X) allow uppercase names
core:default_build_profile: Defines the default build profile ('default' by default)
core:default_profile: Defines the default host profile ('default' by default)
core:non_interactive: Disable interactive user input, raises error if input necessary
core:required_conan_version: Raise if current version does not match the defined range.
core:skip_warnings: Do not show warnings in this list
tools.android:cmake_legacy_toolchain: Define to explicitly pass ANDROID_USE_LEGACY_TOOLCHAIN_FILE in CMake toolchain
tools.android:ndk_path: Argument for the CMAKE_ANDROID_NDK
tools.apple:enable_arc: (boolean) Enable/Disable ARC Apple Clang flags
tools.apple:enable_bitcode: (boolean) Enable/Disable Bitcode Apple Clang flags
Expand All @@ -74,7 +81,7 @@ To list all the possible configurations available, run :command:`conan config li
tools.build:sharedlinkflags: List of extra flags used by CMakeToolchain for CMAKE_SHARED_LINKER_FLAGS_INIT variable
tools.build:skip_test: Do not execute CMake.test() and Meson.test() when enabled
tools.build:sysroot: Pass the --sysroot=<tools.build:sysroot> flag if available. (None by default)
tools.build:verbosity: Verbosity of MSBuild and XCodeBuild build systems. Possible values are 'quiet', 'error', 'warning', 'notice', 'status', 'verbose', 'normal', 'debug', 'v', 'trace' and 'vv'
tools.build:verbosity: Verbosity of build systems if set. Possible values are 'quiet' and 'verbose'
tools.cmake.cmake_layout:build_folder_vars: Settings and Options that will produce a different build folder and different CMake presets names
tools.cmake.cmaketoolchain:find_package_prefer_config: Argument for the CMAKE_FIND_PACKAGE_PREFER_CONFIG
tools.cmake.cmaketoolchain:generator: User defined CMake generator to use instead of default
Expand All @@ -84,6 +91,8 @@ To list all the possible configurations available, run :command:`conan config li
tools.cmake.cmaketoolchain:toolchain_file: Use other existing file rather than conan_toolchain.cmake one
tools.cmake.cmaketoolchain:toolset_arch: Toolset architecture to be used as part of CMAKE_GENERATOR_TOOLSET in CMakeToolchain
tools.cmake.cmaketoolchain:user_toolchain: Inject existing user toolchains at the beginning of conan_toolchain.cmake
tools.cmake:cmake_program: Path to CMake executable
tools.compilation:verbosity: Verbosity of compilation tools if set. Possible values are 'quiet' and 'verbose'
tools.env.virtualenv:powershell: If it is set to True it will generate powershell launchers if os=Windows
tools.files.download:retry: Number of retries in case of failure when downloading
tools.files.download:retry_wait: Seconds to wait between download attempts
Expand All @@ -106,7 +115,7 @@ To list all the possible configurations available, run :command:`conan config li
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.system.package_manager:mode: Mode for package_manager tools: 'check' or 'install'
tools.system.package_manager:mode: Mode for package_manager tools: 'check', 'report', 'report-installed' or 'install'
tools.system.package_manager:sudo: Use 'sudo' when invoking the package manager tools in Linux (False by default)
tools.system.package_manager:sudo_askpass: Use the '-A' argument if using sudo in Linux to invoke the system package manager (False by default)
tools.system.package_manager:tool: Default package manager tool: 'apt-get', 'yum', 'dnf', 'brew', 'pacman', 'choco', 'zypper', 'pkg' or 'pkgutil'
Expand All @@ -122,7 +131,7 @@ Tools and user configurations can be defined in both the *global.conf* file and
.. code-block:: text
:caption: *global.conf*

tools.build:verbosity=debug
tools.build:verbosity=verbose
tools.microsoft.msbuild:max_cpu_count=2
tools.microsoft.msbuild:vs_version = 16
tools.build:jobs=10
Expand Down Expand Up @@ -172,7 +181,7 @@ All the values will be interpreted by Conan as the result of the python built-in
.. code-block:: text

# String
tools.build:verbosity=debug
tools.build:verbosity=verbose
# Boolean
tools.system.package_manager:sudo=True
# Integer
Expand Down
2 changes: 1 addition & 1 deletion reference/config_files/profiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ List of user/tools configurations:
:caption: *myprofile*

[conf]
tools.build:verbosity=debug
tools.build:verbosity=verbose
tools.microsoft.msbuild:max_cpu_count=2
tools.microsoft.msbuild:vs_version = 16
tools.build:jobs=10
Expand Down
6 changes: 4 additions & 2 deletions reference/tools/apple/xcodebuild.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,14 @@ Where:
account** that for this case the skd located in that path should set your ``os.sdk`` and
``os.sdk_version`` settings values.
- ``verbosity`` is the verbosity level for the build and can take value 'verbose' or
'quiet' if set by ``tools.build:verbosity`` by mapping the conf's possible values from your **[conf]**
'quiet' if set by ``tools.build:verbosity`` in your **[conf]**

conf
++++

- ``tools.apple.xcodebuild:verbosity`` verbosity value for the build, can be 'verbose' or 'quiet'
- ``tools.build:verbosity`` (or ``tools.compilation:verbosity`` as fallback) which accepts ``quiet`` or ``verbose``,
and sets the ``-verbose`` or ``-quiet`` flags in ``XcodeBuild.install()``

- ``tools.apple:sdk_path`` path for the sdk location, will set the ``SDKROOT`` value with
preference over composing the value from the ``os.sdk`` and ``os.sdk_version`` settings.

7 changes: 5 additions & 2 deletions reference/tools/cmake/cmake.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,13 @@ conf

The ``CMake()`` build helper is affected by these ``[conf]`` variables:

- ``tools.build:verbosity`` will accept one of ``'quiet', 'error', 'warning', 'notice', 'status', 'verbose', 'normal', 'debug', 'v', 'trace', 'vv'`` to be passed
to the ``CMake.build()`` command, when a Visual Studio generator (MSBuild build system) is being used for CMake. It is passed as
- ``tools.build:verbosity`` will accept one of ``quiet`` or ``verbose`` to be passed to the ``CMake.build()`` command,
when a Visual Studio generator (MSBuild build system) is being used for CMake. It is passed as
an argument to the underlying build system via the call ``cmake --build . --config Release -- /verbosity:Diagnostic``

- ``tools.compilation:verbosity`` will accept one of ``quiet`` or ``verbose`` to be passed to CMake,
which sets ``-DCMAKE_VERBOSE_MAKEFILE`` if ``verbose``

- ``tools.build:jobs`` argument for the ``--jobs`` parameter when running Ninja generator.

- ``tools.microsoft.msbuild:max_cpu_count`` argument for the ``/m`` (``/maxCpuCount``) when running
Expand Down
4 changes: 4 additions & 0 deletions reference/tools/meson/meson.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,7 @@ The ``Meson`` build helper is affected by these ``[conf]`` variables:
native or cross builds. See `this Meson reference
<https://mesonbuild.com/Machine-files.html#loading-multiple-machine-files>`_ for more
information.

- ``tools.compilation:verbosity`` which accepts one of ``quiet`` or ``verbose`` and sets the ``--verbose`` flag in ``Meson.build()``

- ``tools.build:verbosity`` which accepts one of ``quiet`` or ``verbose`` and sets the ``--quiet`` flagh in ``Meson.install()``
4 changes: 2 additions & 2 deletions reference/tools/microsoft/msbuild.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ conf

``MSBuild`` is affected by these ``[conf]`` variables:

- ``tools.build:verbosity`` accepts one of ``'quiet', 'error', 'warning', 'notice', 'status', 'verbose', 'normal', 'debug', 'v', 'trace', 'vv'`` to be passed
to the ``MSBuild.build()`` call as ``msbuild .... /verbosity:XXX``.
- ``tools.build:verbosity`` accepts one of ``quiet`` or ``verbose`` to be passed
to the ``MSBuild.build()`` call as ``msbuild .... /verbosity:{Quiet,Detailed}``.
- ``tools.microsoft.msbuild:max_cpu_count`` maximum number of CPUs to be passed to the ``MSBuild.build()``
call as ``msbuild .... /m:N``.

Expand Down