From 2195145aa7f661316cb779d28353db0d037199a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rub=C3=A9n=20Rinc=C3=B3n=20Blanco?= Date: Thu, 26 Oct 2023 16:35:31 +0200 Subject: [PATCH] Update help commands to newer versions (#3439) --- reference/commands/build.rst | 78 +++---- reference/commands/create.rst | 73 ++++--- reference/commands/graph/build_order.rst | 184 +++++++++++++--- reference/commands/graph/info.rst | 261 +++++++++++------------ reference/commands/install.rst | 74 +++---- reference/commands/lock/create.rst | 143 +++++++------ reference/commands/profile.rst | 93 ++++---- reference/commands/test.rst | 82 +++---- 8 files changed, 553 insertions(+), 435 deletions(-) diff --git a/reference/commands/build.rst b/reference/commands/build.rst index aa0c7a338049..092990ef2432 100644 --- a/reference/commands/build.rst +++ b/reference/commands/build.rst @@ -10,16 +10,17 @@ conan build [--user USER] [--channel CHANNEL] [-g GENERATOR] [-of OUTPUT_FOLDER] [-d DEPLOYER] [--deployer-folder DEPLOYER_FOLDER] [--build-require] - [-b BUILD] [-r REMOTE | -nr] [-u] [-o OPTIONS_HOST] - [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] [-pr PROFILE_HOST] + [-b BUILD] [-r REMOTE | -nr] [-u] [-pr PROFILE] [-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST] - [-s SETTINGS_HOST] [-s:b SETTINGS_BUILD] - [-s:h SETTINGS_HOST] [-c CONF_HOST] [-c:b CONF_BUILD] - [-c:h CONF_HOST] [-l LOCKFILE] [--lockfile-partial] - [--lockfile-out LOCKFILE_OUT] [--lockfile-packages] - [--lockfile-clean] + [-pr:a PROFILE_ALL] [-o OPTIONS] [-o:b OPTIONS_BUILD] + [-o:h OPTIONS_HOST] [-o:a OPTIONS_ALL] [-s SETTINGS] + [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] + [-s:a SETTINGS_ALL] [-c CONF] [-c:b CONF_BUILD] + [-c:h CONF_HOST] [-c:a CONF_ALL] [-l LOCKFILE] + [--lockfile-partial] [--lockfile-out LOCKFILE_OUT] + [--lockfile-packages] [--lockfile-clean] [--lockfile-overrides LOCKFILE_OVERRIDES] - [path] + path Install dependencies and call the build() method. @@ -28,7 +29,7 @@ conan build containing a conanfile.py recipe. conanfile.txt cannot be used with conan build. - optional arguments: + options: -h, --help show this help message and exit -v [V] Level of detail of the output. Valid options from less verbose to more verbose: -vquiet, -verror, -vwarning, @@ -80,42 +81,41 @@ conan build that satisfies the range. Also, if using revisions, it will update to the latest revision for the resolved version range. - -o OPTIONS_HOST, --options OPTIONS_HOST - Define options values (host machine), e.g.: -o - Pkg:with_qt=true - -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD - Define options values (build machine), e.g.: -o:b - Pkg:with_qt=true - -o:h OPTIONS_HOST, --options:host OPTIONS_HOST - Define options values (host machine), e.g.: -o:h - Pkg:with_qt=true - -pr PROFILE_HOST, --profile PROFILE_HOST - Apply the specified profile to the host machine + -pr PROFILE, --profile PROFILE + Apply the specified profile. By default, or if + specifying -pr:h (--profile:host), it applies to the + host context. Use -pr:b (--profile:build) to specify + the build context, or -pr:a (--profile:all) to specify + both contexts at once -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD - Apply the specified profile to the build machine -pr:h PROFILE_HOST, --profile:host PROFILE_HOST - Apply the specified profile to the host machine - -s SETTINGS_HOST, --settings SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s compiler=gcc + -pr:a PROFILE_ALL, --profile:all PROFILE_ALL + -o OPTIONS, --options OPTIONS + Apply the specified options. By default, or if + specifying -o:h (--options:host), it applies to the + host context. Use -o:b (--options:build) to specify + the build context, or -o:a (--options:all) to specify + both contexts at once. Example: -o pkg:with_qt=true + -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD + -o:h OPTIONS_HOST, --options:host OPTIONS_HOST + -o:a OPTIONS_ALL, --options:all OPTIONS_ALL + -s SETTINGS, --settings SETTINGS + Apply the specified settings. By default, or if + specifying -s:h (--settings:host), it applies to the + host context. Use -s:b (--settings:build) to specify + the build context, or -s:a (--settings:all) to specify + both contexts at once. Example: -s compiler=gcc -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD - Settings to build the package, overwriting the - defaults (build machine). e.g.: -s:b compiler=gcc -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s:h compiler=gcc - -c CONF_HOST, --conf CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c - tools.cmake.cmaketoolchain:generator=Xcode + -s:a SETTINGS_ALL, --settings:all SETTINGS_ALL + -c CONF, --conf CONF Apply the specified conf. By default, or if specifying + -c:h (--conf:host), it applies to the host context. + Use -c:b (--conf:build) to specify the build context, + or -c:a (--conf:all) to specify both contexts at once. + Example: -c tools.cmake.cmaketoolchain:generator=Xcode -c:b CONF_BUILD, --conf:build CONF_BUILD - Configuration to build the package, overwriting the - defaults (build machine). e.g.: -c:b - tools.cmake.cmaketoolchain:generator=Xcode -c:h CONF_HOST, --conf:host CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c:h - tools.cmake.cmaketoolchain:generator=Xcode + -c:a CONF_ALL, --conf:all CONF_ALL -l LOCKFILE, --lockfile LOCKFILE Path to a lockfile. Use --lockfile="" to avoid automatic use of existing 'conan.lock' file diff --git a/reference/commands/create.rst b/reference/commands/create.rst index 17ef4a647ae0..7d34befd5058 100644 --- a/reference/commands/create.rst +++ b/reference/commands/create.rst @@ -10,13 +10,13 @@ conan create [--lockfile-out LOCKFILE_OUT] [--lockfile-packages] [--lockfile-clean] [--lockfile-overrides LOCKFILE_OVERRIDES] [-b BUILD] - [-r REMOTE | -nr] [-u] [-o OPTIONS_HOST] + [-r REMOTE | -nr] [-u] [-pr PROFILE] [-pr:b PROFILE_BUILD] + [-pr:h PROFILE_HOST] [-pr:a PROFILE_ALL] [-o OPTIONS] [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] - [-pr PROFILE_HOST] [-pr:b PROFILE_BUILD] - [-pr:h PROFILE_HOST] [-s SETTINGS_HOST] - [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] [-c CONF_HOST] - [-c:b CONF_BUILD] [-c:h CONF_HOST] [--build-require] - [-tf TEST_FOLDER] [-bt BUILD_TEST] + [-o:a OPTIONS_ALL] [-s SETTINGS] [-s:b SETTINGS_BUILD] + [-s:h SETTINGS_HOST] [-s:a SETTINGS_ALL] [-c CONF] + [-c:b CONF_BUILD] [-c:h CONF_HOST] [-c:a CONF_ALL] + [--build-require] [-tf TEST_FOLDER] [-bt BUILD_TEST] path Create a package. @@ -24,7 +24,7 @@ conan create positional arguments: path Path to a folder containing a recipe (conanfile.py) - optional arguments: + options: -h, --help show this help message and exit -v [V] Level of detail of the output. Valid options from less verbose to more verbose: -vquiet, -verror, -vwarning, @@ -78,42 +78,41 @@ conan create that satisfies the range. Also, if using revisions, it will update to the latest revision for the resolved version range. - -o OPTIONS_HOST, --options OPTIONS_HOST - Define options values (host machine), e.g.: -o - Pkg:with_qt=true - -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD - Define options values (build machine), e.g.: -o:b - Pkg:with_qt=true - -o:h OPTIONS_HOST, --options:host OPTIONS_HOST - Define options values (host machine), e.g.: -o:h - Pkg:with_qt=true - -pr PROFILE_HOST, --profile PROFILE_HOST - Apply the specified profile to the host machine + -pr PROFILE, --profile PROFILE + Apply the specified profile. By default, or if + specifying -pr:h (--profile:host), it applies to the + host context. Use -pr:b (--profile:build) to specify + the build context, or -pr:a (--profile:all) to specify + both contexts at once -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD - Apply the specified profile to the build machine -pr:h PROFILE_HOST, --profile:host PROFILE_HOST - Apply the specified profile to the host machine - -s SETTINGS_HOST, --settings SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s compiler=gcc + -pr:a PROFILE_ALL, --profile:all PROFILE_ALL + -o OPTIONS, --options OPTIONS + Apply the specified options. By default, or if + specifying -o:h (--options:host), it applies to the + host context. Use -o:b (--options:build) to specify + the build context, or -o:a (--options:all) to specify + both contexts at once. Example: -o pkg:with_qt=true + -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD + -o:h OPTIONS_HOST, --options:host OPTIONS_HOST + -o:a OPTIONS_ALL, --options:all OPTIONS_ALL + -s SETTINGS, --settings SETTINGS + Apply the specified settings. By default, or if + specifying -s:h (--settings:host), it applies to the + host context. Use -s:b (--settings:build) to specify + the build context, or -s:a (--settings:all) to specify + both contexts at once. Example: -s compiler=gcc -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD - Settings to build the package, overwriting the - defaults (build machine). e.g.: -s:b compiler=gcc -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s:h compiler=gcc - -c CONF_HOST, --conf CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c - tools.cmake.cmaketoolchain:generator=Xcode + -s:a SETTINGS_ALL, --settings:all SETTINGS_ALL + -c CONF, --conf CONF Apply the specified conf. By default, or if specifying + -c:h (--conf:host), it applies to the host context. + Use -c:b (--conf:build) to specify the build context, + or -c:a (--conf:all) to specify both contexts at once. + Example: -c tools.cmake.cmaketoolchain:generator=Xcode -c:b CONF_BUILD, --conf:build CONF_BUILD - Configuration to build the package, overwriting the - defaults (build machine). e.g.: -c:b - tools.cmake.cmaketoolchain:generator=Xcode -c:h CONF_HOST, --conf:host CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c:h - tools.cmake.cmaketoolchain:generator=Xcode + -c:a CONF_ALL, --conf:all CONF_ALL --build-require Whether the package being created is a build-require (to be used as tool_requires() by other packages) -tf TEST_FOLDER, --test-folder TEST_FOLDER diff --git a/reference/commands/graph/build_order.rst b/reference/commands/graph/build_order.rst index 54b66fdb4add..281f9e7e996e 100644 --- a/reference/commands/graph/build_order.rst +++ b/reference/commands/graph/build_order.rst @@ -8,13 +8,14 @@ conan graph build-order [--version VERSION] [--user USER] [--channel CHANNEL] [--requires REQUIRES] [--tool-requires TOOL_REQUIRES] [-b BUILD] - [-r REMOTE | -nr] [-u] [-o OPTIONS_HOST] + [-r REMOTE | -nr] [-u] [-pr PROFILE] + [-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST] + [-pr:a PROFILE_ALL] [-o OPTIONS] [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] - [-pr PROFILE_HOST] [-pr:b PROFILE_BUILD] - [-pr:h PROFILE_HOST] [-s SETTINGS_HOST] + [-o:a OPTIONS_ALL] [-s SETTINGS] [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] - [-c CONF_HOST] [-c:b CONF_BUILD] - [-c:h CONF_HOST] [-l LOCKFILE] + [-s:a SETTINGS_ALL] [-c CONF] [-c:b CONF_BUILD] + [-c:h CONF_HOST] [-c:a CONF_ALL] [-l LOCKFILE] [--lockfile-partial] [--lockfile-out LOCKFILE_OUT] [--lockfile-packages] [--lockfile-clean] @@ -28,7 +29,7 @@ conan graph build-order conanfile.txt) or to a recipe file. e.g., ./my_project/conanfile.txt. - optional arguments: + options: -h, --help show this help message and exit -f FORMAT, --format FORMAT Select the output format: json @@ -74,42 +75,157 @@ conan graph build-order that satisfies the range. Also, if using revisions, it will update to the latest revision for the resolved version range. - -o OPTIONS_HOST, --options OPTIONS_HOST - Define options values (host machine), e.g.: -o - Pkg:with_qt=true + -pr PROFILE, --profile PROFILE + Apply the specified profile. By default, or if + specifying -pr:h (--profile:host), it applies to the + host context. Use -pr:b (--profile:build) to specify + the build context, or -pr:a (--profile:all) to specify + both contexts at once + -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD + -pr:h PROFILE_HOST, --profile:host PROFILE_HOST + -pr:a PROFILE_ALL, --profile:all PROFILE_ALL + -o OPTIONS, --options OPTIONS + Apply the specified options. By default, or if + specifying -o:h (--options:host), it applies to the + host context. Use -o:b (--options:build) to specify + the build context, or -o:a (--options:all) to specify + both contexts at once. Example: -o pkg:with_qt=true -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD - Define options values (build machine), e.g.: -o:b - Pkg:with_qt=true -o:h OPTIONS_HOST, --options:host OPTIONS_HOST - Define options values (host machine), e.g.: -o:h - Pkg:with_qt=true - -pr PROFILE_HOST, --profile PROFILE_HOST - Apply the specified profile to the host machine + -o:a OPTIONS_ALL, --options:all OPTIONS_ALL + -s SETTINGS, --settings SETTINGS + Apply the specified settings. By default, or if + specifying -s:h (--settings:host), it applies to the + host context. Use -s:b (--settings:build) to specify + the build context, or -s:a (--settings:all) to specify + both contexts at once. Example: -s compiler=gcc + -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD + -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST + -s:a SETTINGS_ALL, --settings:all SETTINGS_ALL + -c CONF, --conf CONF Apply the specified conf. By default, or if specifying + -c:h (--conf:host), it applies to the host context. + Use -c:b (--conf:build) to specify the build context, + or -c:a (--conf:all) to specify both contexts at once. + Example: -c tools.cmake.cmaketoolchain:generator=Xcode + -c:b CONF_BUILD, --conf:build CONF_BUILD + -c:h CONF_HOST, --conf:host CONF_HOST + -c:a CONF_ALL, --conf:all CONF_ALL + -l LOCKFILE, --lockfile LOCKFILE + Path to a lockfile. Use --lockfile="" to avoid + automatic use of existing 'conan.lock' file + --lockfile-partial Do not raise an error if some dependency is not found + in lockfile + --lockfile-out LOCKFILE_OUT + Filename of the updated lockfile + --lockfile-packages Lock package-id and package-revision information + --lockfile-clean Remove unused entries from the lockfile + --lockfile-overrides LOCKFILE_OVERRIDES + Overwrite lockfile overridesusage: conan graph build-order [-h] [-f FORMAT] [-v [V]] [--name NAME] + [--version VERSION] [--user USER] + [--channel CHANNEL] [--requires REQUIRES] + [--tool-requires TOOL_REQUIRES] [-b BUILD] + [-r REMOTE | -nr] [-u] [-pr PROFILE] + [-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST] + [-pr:a PROFILE_ALL] [-o OPTIONS] + [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] + [-o:a OPTIONS_ALL] [-s SETTINGS] + [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] + [-s:a SETTINGS_ALL] [-c CONF] [-c:b CONF_BUILD] + [-c:h CONF_HOST] [-c:a CONF_ALL] [-l LOCKFILE] + [--lockfile-partial] + [--lockfile-out LOCKFILE_OUT] + [--lockfile-packages] [--lockfile-clean] + [--lockfile-overrides LOCKFILE_OVERRIDES] + [path] + + Compute the build order of a dependency graph. + + positional arguments: + path Path to a folder containing a recipe (conanfile.py or + conanfile.txt) or to a recipe file. e.g., + ./my_project/conanfile.txt. + + options: + -h, --help show this help message and exit + -f FORMAT, --format FORMAT + Select the output format: json + -v [V] Level of detail of the output. Valid options from less + verbose to more verbose: -vquiet, -verror, -vwarning, + -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug, + -vvv or -vtrace + --name NAME Provide a package name if not specified in conanfile + --version VERSION Provide a package version if not specified in + conanfile + --user USER Provide a user if not specified in conanfile + --channel CHANNEL Provide a channel if not specified in conanfile + --requires REQUIRES Directly provide requires instead of a conanfile + --tool-requires TOOL_REQUIRES + Directly provide tool-requires instead of a conanfile + -b BUILD, --build BUILD + Optional, specify which packages to build from source. + Combining multiple '--build' options on one command + line is allowed. Possible values: --build="*" Force + build from source for all packages. --build=never + Disallow build for all packages, use binary packages + or fail if a binary package is not found, it cannot be + combined with other '--build' options. --build=missing + Build packages from source whose binary package is not + found. --build=cascade Build packages from source that + have at least one dependency being built from source. + --build=[pattern] Build packages from source whose + package reference matches the pattern. The pattern + uses 'fnmatch' style wildcards. --build=~[pattern] + Excluded packages, which will not be built from the + source, whose package reference matches the pattern. + The pattern uses 'fnmatch' style wildcards. + --build=missing:[pattern] Build from source if a + compatible binary does not exist, only for packages + matching pattern. + -r REMOTE, --remote REMOTE + Look in the specified remote or remotes server + -nr, --no-remote Do not use remote, resolve exclusively in the cache + -u, --update Will check the remote and in case a newer version + and/or revision of the dependencies exists there, it + will install those in the local cache. When using + version ranges, it will install the latest version + that satisfies the range. Also, if using revisions, it + will update to the latest revision for the resolved + version range. + -pr PROFILE, --profile PROFILE + Apply the specified profile. By default, or if + specifying -pr:h (--profile:host), it applies to the + host context. Use -pr:b (--profile:build) to specify + the build context, or -pr:a (--profile:all) to specify + both contexts at once -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD - Apply the specified profile to the build machine -pr:h PROFILE_HOST, --profile:host PROFILE_HOST - Apply the specified profile to the host machine - -s SETTINGS_HOST, --settings SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s compiler=gcc + -pr:a PROFILE_ALL, --profile:all PROFILE_ALL + -o OPTIONS, --options OPTIONS + Apply the specified options. By default, or if + specifying -o:h (--options:host), it applies to the + host context. Use -o:b (--options:build) to specify + the build context, or -o:a (--options:all) to specify + both contexts at once. Example: -o pkg:with_qt=true + -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD + -o:h OPTIONS_HOST, --options:host OPTIONS_HOST + -o:a OPTIONS_ALL, --options:all OPTIONS_ALL + -s SETTINGS, --settings SETTINGS + Apply the specified settings. By default, or if + specifying -s:h (--settings:host), it applies to the + host context. Use -s:b (--settings:build) to specify + the build context, or -s:a (--settings:all) to specify + both contexts at once. Example: -s compiler=gcc -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD - Settings to build the package, overwriting the - defaults (build machine). e.g.: -s:b compiler=gcc -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s:h compiler=gcc - -c CONF_HOST, --conf CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c - tools.cmake.cmaketoolchain:generator=Xcode + -s:a SETTINGS_ALL, --settings:all SETTINGS_ALL + -c CONF, --conf CONF Apply the specified conf. By default, or if specifying + -c:h (--conf:host), it applies to the host context. + Use -c:b (--conf:build) to specify the build context, + or -c:a (--conf:all) to specify both contexts at once. + Example: -c tools.cmake.cmaketoolchain:generator=Xcode -c:b CONF_BUILD, --conf:build CONF_BUILD - Configuration to build the package, overwriting the - defaults (build machine). e.g.: -c:b - tools.cmake.cmaketoolchain:generator=Xcode -c:h CONF_HOST, --conf:host CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c:h - tools.cmake.cmaketoolchain:generator=Xcode + -c:a CONF_ALL, --conf:all CONF_ALL -l LOCKFILE, --lockfile LOCKFILE Path to a lockfile. Use --lockfile="" to avoid automatic use of existing 'conan.lock' file diff --git a/reference/commands/graph/info.rst b/reference/commands/graph/info.rst index 10a52a9ed34b..e600c631d773 100644 --- a/reference/commands/graph/info.rst +++ b/reference/commands/graph/info.rst @@ -5,137 +5,136 @@ conan graph info .. code-block:: text - $ conan graph info -h - usage: conan graph info [-h] [-f FORMAT] [-v [V]] [--name NAME] - [--version VERSION] [--user USER] [--channel CHANNEL] - [--requires REQUIRES] [--tool-requires TOOL_REQUIRES] - [-b BUILD] [-r REMOTE | -nr] [-u] [-o OPTIONS_HOST] - [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] - [-pr PROFILE_HOST] [-pr:b PROFILE_BUILD] - [-pr:h PROFILE_HOST] [-s SETTINGS_HOST] - [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] - [-c CONF_HOST] [-c:b CONF_BUILD] [-c:h CONF_HOST] - [-l LOCKFILE] [--lockfile-partial] - [--lockfile-out LOCKFILE_OUT] [--lockfile-packages] - [--lockfile-clean] - [--lockfile-overrides LOCKFILE_OVERRIDES] - [--check-updates] [--filter FILTER] - [--package-filter PACKAGE_FILTER] [-d DEPLOYER] - [-df DEPLOYER_FOLDER] [--build-require] - [path] - - Compute the dependency graph and show information about it. - - positional arguments: - path Path to a folder containing a recipe (conanfile.py or - conanfile.txt) or to a recipe file. e.g., - ./my_project/conanfile.txt. - - optional arguments: - -h, --help show this help message and exit - -f FORMAT, --format FORMAT - Select the output format: html, json, dot - -v [V] Level of detail of the output. Valid options from less - verbose to more verbose: -vquiet, -verror, -vwarning, - -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug, - -vvv or -vtrace - --name NAME Provide a package name if not specified in conanfile - --version VERSION Provide a package version if not specified in - conanfile - --user USER Provide a user if not specified in conanfile - --channel CHANNEL Provide a channel if not specified in conanfile - --requires REQUIRES Directly provide requires instead of a conanfile - --tool-requires TOOL_REQUIRES - Directly provide tool-requires instead of a conanfile - -b BUILD, --build BUILD - Optional, specify which packages to build from source. - Combining multiple '--build' options on one command - line is allowed. Possible values: --build="*" Force - build from source for all packages. --build=never - Disallow build for all packages, use binary packages - or fail if a binary package is not found, it cannot be - combined with other '--build' options. --build=missing - Build packages from source whose binary package is not - found. --build=cascade Build packages from source that - have at least one dependency being built from source. - --build=[pattern] Build packages from source whose - package reference matches the pattern. The pattern - uses 'fnmatch' style wildcards. --build=~[pattern] - Excluded packages, which will not be built from the - source, whose package reference matches the pattern. - The pattern uses 'fnmatch' style wildcards. - --build=missing:[pattern] Build from source if a - compatible binary does not exist, only for packages - matching pattern. - -r REMOTE, --remote REMOTE - Look in the specified remote or remotes server - -nr, --no-remote Do not use remote, resolve exclusively in the cache - -u, --update Will check the remote and in case a newer version - and/or revision of the dependencies exists there, it - will install those in the local cache. When using - version ranges, it will install the latest version - that satisfies the range. Also, if using revisions, it - will update to the latest revision for the resolved - version range. - -o OPTIONS_HOST, --options OPTIONS_HOST - Define options values (host machine), e.g.: -o - Pkg:with_qt=true - -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD - Define options values (build machine), e.g.: -o:b - Pkg:with_qt=true - -o:h OPTIONS_HOST, --options:host OPTIONS_HOST - Define options values (host machine), e.g.: -o:h - Pkg:with_qt=true - -pr PROFILE_HOST, --profile PROFILE_HOST - Apply the specified profile to the host machine - -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD - Apply the specified profile to the build machine - -pr:h PROFILE_HOST, --profile:host PROFILE_HOST - Apply the specified profile to the host machine - -s SETTINGS_HOST, --settings SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s compiler=gcc - -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD - Settings to build the package, overwriting the - defaults (build machine). e.g.: -s:b compiler=gcc - -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s:h compiler=gcc - -c CONF_HOST, --conf CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c - tools.cmake.cmaketoolchain:generator=Xcode - -c:b CONF_BUILD, --conf:build CONF_BUILD - Configuration to build the package, overwriting the - defaults (build machine). e.g.: -c:b - tools.cmake.cmaketoolchain:generator=Xcode - -c:h CONF_HOST, --conf:host CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c:h - tools.cmake.cmaketoolchain:generator=Xcode - -l LOCKFILE, --lockfile LOCKFILE - Path to a lockfile. Use --lockfile="" to avoid - automatic use of existing 'conan.lock' file - --lockfile-partial Do not raise an error if some dependency is not found - in lockfile - --lockfile-out LOCKFILE_OUT - Filename of the updated lockfile - --lockfile-packages Lock package-id and package-revision information - --lockfile-clean Remove unused entries from the lockfile - --lockfile-overrides LOCKFILE_OVERRIDES - Overwrite lockfile overrides - --check-updates Check if there are recipe updates - --filter FILTER Show only the specified fields - --package-filter PACKAGE_FILTER - Print information only for packages that match the - patterns - -d DEPLOYER, --deployer DEPLOYER - Deploy using the provided deployer to the output - folder - -df DEPLOYER_FOLDER, --deployer-folder DEPLOYER_FOLDER - Deployer output folder, base build folder by default - if not set - --build-require Whether the provided reference is a build-require + $ conan graph info -h + usage: conan graph info [-h] [-f FORMAT] [-v [V]] [--name NAME] + [--version VERSION] [--user USER] [--channel CHANNEL] + [--requires REQUIRES] [--tool-requires TOOL_REQUIRES] + [-b BUILD] [-r REMOTE | -nr] [-u] [-pr PROFILE] + [-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST] + [-pr:a PROFILE_ALL] [-o OPTIONS] [-o:b OPTIONS_BUILD] + [-o:h OPTIONS_HOST] [-o:a OPTIONS_ALL] [-s SETTINGS] + [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] + [-s:a SETTINGS_ALL] [-c CONF] [-c:b CONF_BUILD] + [-c:h CONF_HOST] [-c:a CONF_ALL] [-l LOCKFILE] + [--lockfile-partial] [--lockfile-out LOCKFILE_OUT] + [--lockfile-packages] [--lockfile-clean] + [--lockfile-overrides LOCKFILE_OVERRIDES] + [--check-updates] [--filter FILTER] + [--package-filter PACKAGE_FILTER] [-d DEPLOYER] + [-df DEPLOYER_FOLDER] [--build-require] + [path] + + Compute the dependency graph and show information about it. + + positional arguments: + path Path to a folder containing a recipe (conanfile.py or + conanfile.txt) or to a recipe file. e.g., + ./my_project/conanfile.txt. + + options: + -h, --help show this help message and exit + -f FORMAT, --format FORMAT + Select the output format: html, json, dot + -v [V] Level of detail of the output. Valid options from less + verbose to more verbose: -vquiet, -verror, -vwarning, + -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug, + -vvv or -vtrace + --name NAME Provide a package name if not specified in conanfile + --version VERSION Provide a package version if not specified in + conanfile + --user USER Provide a user if not specified in conanfile + --channel CHANNEL Provide a channel if not specified in conanfile + --requires REQUIRES Directly provide requires instead of a conanfile + --tool-requires TOOL_REQUIRES + Directly provide tool-requires instead of a conanfile + -b BUILD, --build BUILD + Optional, specify which packages to build from source. + Combining multiple '--build' options on one command + line is allowed. Possible values: --build="*" Force + build from source for all packages. --build=never + Disallow build for all packages, use binary packages + or fail if a binary package is not found, it cannot be + combined with other '--build' options. --build=missing + Build packages from source whose binary package is not + found. --build=cascade Build packages from source that + have at least one dependency being built from source. + --build=[pattern] Build packages from source whose + package reference matches the pattern. The pattern + uses 'fnmatch' style wildcards. --build=~[pattern] + Excluded packages, which will not be built from the + source, whose package reference matches the pattern. + The pattern uses 'fnmatch' style wildcards. + --build=missing:[pattern] Build from source if a + compatible binary does not exist, only for packages + matching pattern. + -r REMOTE, --remote REMOTE + Look in the specified remote or remotes server + -nr, --no-remote Do not use remote, resolve exclusively in the cache + -u, --update Will check the remote and in case a newer version + and/or revision of the dependencies exists there, it + will install those in the local cache. When using + version ranges, it will install the latest version + that satisfies the range. Also, if using revisions, it + will update to the latest revision for the resolved + version range. + -pr PROFILE, --profile PROFILE + Apply the specified profile. By default, or if + specifying -pr:h (--profile:host), it applies to the + host context. Use -pr:b (--profile:build) to specify + the build context, or -pr:a (--profile:all) to specify + both contexts at once + -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD + -pr:h PROFILE_HOST, --profile:host PROFILE_HOST + -pr:a PROFILE_ALL, --profile:all PROFILE_ALL + -o OPTIONS, --options OPTIONS + Apply the specified options. By default, or if + specifying -o:h (--options:host), it applies to the + host context. Use -o:b (--options:build) to specify + the build context, or -o:a (--options:all) to specify + both contexts at once. Example: -o pkg:with_qt=true + -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD + -o:h OPTIONS_HOST, --options:host OPTIONS_HOST + -o:a OPTIONS_ALL, --options:all OPTIONS_ALL + -s SETTINGS, --settings SETTINGS + Apply the specified settings. By default, or if + specifying -s:h (--settings:host), it applies to the + host context. Use -s:b (--settings:build) to specify + the build context, or -s:a (--settings:all) to specify + both contexts at once. Example: -s compiler=gcc + -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD + -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST + -s:a SETTINGS_ALL, --settings:all SETTINGS_ALL + -c CONF, --conf CONF Apply the specified conf. By default, or if specifying + -c:h (--conf:host), it applies to the host context. + Use -c:b (--conf:build) to specify the build context, + or -c:a (--conf:all) to specify both contexts at once. + Example: -c tools.cmake.cmaketoolchain:generator=Xcode + -c:b CONF_BUILD, --conf:build CONF_BUILD + -c:h CONF_HOST, --conf:host CONF_HOST + -c:a CONF_ALL, --conf:all CONF_ALL + -l LOCKFILE, --lockfile LOCKFILE + Path to a lockfile. Use --lockfile="" to avoid + automatic use of existing 'conan.lock' file + --lockfile-partial Do not raise an error if some dependency is not found + in lockfile + --lockfile-out LOCKFILE_OUT + Filename of the updated lockfile + --lockfile-packages Lock package-id and package-revision information + --lockfile-clean Remove unused entries from the lockfile + --lockfile-overrides LOCKFILE_OVERRIDES + Overwrite lockfile overrides + --check-updates Check if there are recipe updates + --filter FILTER Show only the specified fields + --package-filter PACKAGE_FILTER + Print information only for packages that match the + patterns + -d DEPLOYER, --deployer DEPLOYER + Deploy using the provided deployer to the output + folder + -df DEPLOYER_FOLDER, --deployer-folder DEPLOYER_FOLDER + Deployer output folder, base build folder by default + if not set + --build-require Whether the provided reference is a build-require The ``conan graph info`` command shows information about the dependency graph for the recipe specified in ``path``. diff --git a/reference/commands/install.rst b/reference/commands/install.rst index 67e9b56e5d4d..bc245f248522 100644 --- a/reference/commands/install.rst +++ b/reference/commands/install.rst @@ -9,12 +9,13 @@ conan install usage: conan install [-h] [-v [V]] [-f FORMAT] [--name NAME] [--version VERSION] [--user USER] [--channel CHANNEL] [--requires REQUIRES] [--tool-requires TOOL_REQUIRES] - [-b BUILD] [-r REMOTE | -nr] [-u] [-o OPTIONS_HOST] - [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] - [-pr PROFILE_HOST] [-pr:b PROFILE_BUILD] - [-pr:h PROFILE_HOST] [-s SETTINGS_HOST] - [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] [-c CONF_HOST] - [-c:b CONF_BUILD] [-c:h CONF_HOST] [-l LOCKFILE] + [-b BUILD] [-r REMOTE | -nr] [-u] [-pr PROFILE] + [-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST] + [-pr:a PROFILE_ALL] [-o OPTIONS] [-o:b OPTIONS_BUILD] + [-o:h OPTIONS_HOST] [-o:a OPTIONS_ALL] [-s SETTINGS] + [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] + [-s:a SETTINGS_ALL] [-c CONF] [-c:b CONF_BUILD] + [-c:h CONF_HOST] [-c:a CONF_ALL] [-l LOCKFILE] [--lockfile-partial] [--lockfile-out LOCKFILE_OUT] [--lockfile-packages] [--lockfile-clean] [--lockfile-overrides LOCKFILE_OVERRIDES] [-g GENERATOR] @@ -40,7 +41,7 @@ conan install conanfile.txt) or to a recipe file. e.g., ./my_project/conanfile.txt. - optional arguments: + options: -h, --help show this help message and exit -v [V] Level of detail of the output. Valid options from less verbose to more verbose: -vquiet, -verror, -vwarning, @@ -86,42 +87,41 @@ conan install that satisfies the range. Also, if using revisions, it will update to the latest revision for the resolved version range. - -o OPTIONS_HOST, --options OPTIONS_HOST - Define options values (host machine), e.g.: -o - Pkg:with_qt=true - -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD - Define options values (build machine), e.g.: -o:b - Pkg:with_qt=true - -o:h OPTIONS_HOST, --options:host OPTIONS_HOST - Define options values (host machine), e.g.: -o:h - Pkg:with_qt=true - -pr PROFILE_HOST, --profile PROFILE_HOST - Apply the specified profile to the host machine + -pr PROFILE, --profile PROFILE + Apply the specified profile. By default, or if + specifying -pr:h (--profile:host), it applies to the + host context. Use -pr:b (--profile:build) to specify + the build context, or -pr:a (--profile:all) to specify + both contexts at once -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD - Apply the specified profile to the build machine -pr:h PROFILE_HOST, --profile:host PROFILE_HOST - Apply the specified profile to the host machine - -s SETTINGS_HOST, --settings SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s compiler=gcc + -pr:a PROFILE_ALL, --profile:all PROFILE_ALL + -o OPTIONS, --options OPTIONS + Apply the specified options. By default, or if + specifying -o:h (--options:host), it applies to the + host context. Use -o:b (--options:build) to specify + the build context, or -o:a (--options:all) to specify + both contexts at once. Example: -o pkg:with_qt=true + -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD + -o:h OPTIONS_HOST, --options:host OPTIONS_HOST + -o:a OPTIONS_ALL, --options:all OPTIONS_ALL + -s SETTINGS, --settings SETTINGS + Apply the specified settings. By default, or if + specifying -s:h (--settings:host), it applies to the + host context. Use -s:b (--settings:build) to specify + the build context, or -s:a (--settings:all) to specify + both contexts at once. Example: -s compiler=gcc -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD - Settings to build the package, overwriting the - defaults (build machine). e.g.: -s:b compiler=gcc -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s:h compiler=gcc - -c CONF_HOST, --conf CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c - tools.cmake.cmaketoolchain:generator=Xcode + -s:a SETTINGS_ALL, --settings:all SETTINGS_ALL + -c CONF, --conf CONF Apply the specified conf. By default, or if specifying + -c:h (--conf:host), it applies to the host context. + Use -c:b (--conf:build) to specify the build context, + or -c:a (--conf:all) to specify both contexts at once. + Example: -c tools.cmake.cmaketoolchain:generator=Xcode -c:b CONF_BUILD, --conf:build CONF_BUILD - Configuration to build the package, overwriting the - defaults (build machine). e.g.: -c:b - tools.cmake.cmaketoolchain:generator=Xcode -c:h CONF_HOST, --conf:host CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c:h - tools.cmake.cmaketoolchain:generator=Xcode + -c:a CONF_ALL, --conf:all CONF_ALL -l LOCKFILE, --lockfile LOCKFILE Path to a lockfile. Use --lockfile="" to avoid automatic use of existing 'conan.lock' file diff --git a/reference/commands/lock/create.rst b/reference/commands/lock/create.rst index 7b9231132f24..57201bfb6935 100644 --- a/reference/commands/lock/create.rst +++ b/reference/commands/lock/create.rst @@ -5,116 +5,119 @@ conan lock create $ conan lock create -h usage: conan lock create [-h] [-v [V]] [--name NAME] [--version VERSION] - [--user USER] [--channel CHANNEL] - [--requires REQUIRES] [--tool-requires TOOL_REQUIRES] - [-b BUILD] [-r REMOTE | -nr] [-u] [-o OPTIONS_HOST] - [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] - [-pr PROFILE_HOST] [-pr:b PROFILE_BUILD] - [-pr:h PROFILE_HOST] [-s SETTINGS_HOST] - [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] - [-c CONF_HOST] [-c:b CONF_BUILD] [-c:h CONF_HOST] - [-l LOCKFILE] [--lockfile-partial] - [--lockfile-out LOCKFILE_OUT] [--lockfile-packages] - [--lockfile-clean] [--build-require] - [path] + [--user USER] [--channel CHANNEL] + [--requires REQUIRES] [--tool-requires TOOL_REQUIRES] + [-b BUILD] [-r REMOTE | -nr] [-u] [-pr PROFILE] + [-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST] + [-pr:a PROFILE_ALL] [-o OPTIONS] [-o:b OPTIONS_BUILD] + [-o:h OPTIONS_HOST] [-o:a OPTIONS_ALL] [-s SETTINGS] + [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] + [-s:a SETTINGS_ALL] [-c CONF] [-c:b CONF_BUILD] + [-c:h CONF_HOST] [-c:a CONF_ALL] [-l LOCKFILE] + [--lockfile-partial] [--lockfile-out LOCKFILE_OUT] + [--lockfile-packages] [--lockfile-clean] + [--lockfile-overrides LOCKFILE_OVERRIDES] + [--build-require] + [path] Create a lockfile from a conanfile or a reference. positional arguments: - path Path to a folder containing a recipe (conanfile.py or + path Path to a folder containing a recipe (conanfile.py or conanfile.txt) or to a recipe file. e.g., ./my_project/conanfile.txt. - optional arguments: - -h, --help show this help message and exit - -v [V] Level of detail of the output. Valid options from less + options: + -h, --help show this help message and exit + -v [V] Level of detail of the output. Valid options from less verbose to more verbose: -vquiet, -verror, -vwarning, -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug, -vvv or -vtrace - --name NAME Provide a package name if not specified in conanfile - --version VERSION Provide a package version if not specified in + --name NAME Provide a package name if not specified in conanfile + --version VERSION Provide a package version if not specified in conanfile - --user USER Provide a user if not specified in conanfile - --channel CHANNEL Provide a channel if not specified in conanfile - --requires REQUIRES Directly provide requires instead of a conanfile - --tool-requires TOOL_REQUIRES + --user USER Provide a user if not specified in conanfile + --channel CHANNEL Provide a channel if not specified in conanfile + --requires REQUIRES Directly provide requires instead of a conanfile + --tool-requires TOOL_REQUIRES Directly provide tool-requires instead of a conanfile - -b BUILD, --build BUILD + -b BUILD, --build BUILD Optional, specify which packages to build from source. Combining multiple '--build' options on one command line is allowed. Possible values: --build="*" Force build from source for all packages. --build=never Disallow build for all packages, use binary packages - or fail if a binary package is not found. Cannot be + or fail if a binary package is not found, it cannot be combined with other '--build' options. --build=missing Build packages from source whose binary package is not found. --build=cascade Build packages from source that have at least one dependency being built from source. --build=[pattern] Build packages from source whose package reference matches the pattern. The pattern - uses 'fnmatch' style wildcards. --build=![pattern] + uses 'fnmatch' style wildcards. --build=~[pattern] Excluded packages, which will not be built from the source, whose package reference matches the pattern. The pattern uses 'fnmatch' style wildcards. --build=missing:[pattern] Build from source if a compatible binary does not exist, only for packages matching pattern. - -r REMOTE, --remote REMOTE + -r REMOTE, --remote REMOTE Look in the specified remote or remotes server - -nr, --no-remote Do not use remote, resolve exclusively in the cache - -u, --update Will check the remote and in case a newer version + -nr, --no-remote Do not use remote, resolve exclusively in the cache + -u, --update Will check the remote and in case a newer version and/or revision of the dependencies exists there, it will install those in the local cache. When using version ranges, it will install the latest version that satisfies the range. Also, if using revisions, it will update to the latest revision for the resolved version range. - -o OPTIONS_HOST, --options OPTIONS_HOST - Define options values (host machine), e.g.: -o - Pkg:with_qt=true - -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD - Define options values (build machine), e.g.: -o:b - Pkg:with_qt=true - -o:h OPTIONS_HOST, --options:host OPTIONS_HOST - Define options values (host machine), e.g.: -o:h - Pkg:with_qt=true - -pr PROFILE_HOST, --profile PROFILE_HOST - Apply the specified profile to the host machine - -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD - Apply the specified profile to the build machine - -pr:h PROFILE_HOST, --profile:host PROFILE_HOST - Apply the specified profile to the host machine - -s SETTINGS_HOST, --settings SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s compiler=gcc - -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD - Settings to build the package, overwriting the - defaults (build machine). e.g.: -s:b compiler=gcc - -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s:h compiler=gcc - -c CONF_HOST, --conf CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c - tools.cmake.cmaketoolchain:generator=Xcode - -c:b CONF_BUILD, --conf:build CONF_BUILD - Configuration to build the package, overwriting the - defaults (build machine). e.g.: -c:b - tools.cmake.cmaketoolchain:generator=Xcode - -c:h CONF_HOST, --conf:host CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c:h - tools.cmake.cmaketoolchain:generator=Xcode - -l LOCKFILE, --lockfile LOCKFILE + -pr PROFILE, --profile PROFILE + Apply the specified profile. By default, or if + specifying -pr:h (--profile:host), it applies to the + host context. Use -pr:b (--profile:build) to specify + the build context, or -pr:a (--profile:all) to specify + both contexts at once + -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD + -pr:h PROFILE_HOST, --profile:host PROFILE_HOST + -pr:a PROFILE_ALL, --profile:all PROFILE_ALL + -o OPTIONS, --options OPTIONS + Apply the specified options. By default, or if + specifying -o:h (--options:host), it applies to the + host context. Use -o:b (--options:build) to specify + the build context, or -o:a (--options:all) to specify + both contexts at once. Example: -o pkg:with_qt=true + -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD + -o:h OPTIONS_HOST, --options:host OPTIONS_HOST + -o:a OPTIONS_ALL, --options:all OPTIONS_ALL + -s SETTINGS, --settings SETTINGS + Apply the specified settings. By default, or if + specifying -s:h (--settings:host), it applies to the + host context. Use -s:b (--settings:build) to specify + the build context, or -s:a (--settings:all) to specify + both contexts at once. Example: -s compiler=gcc + -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD + -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST + -s:a SETTINGS_ALL, --settings:all SETTINGS_ALL + -c CONF, --conf CONF Apply the specified conf. By default, or if specifying + -c:h (--conf:host), it applies to the host context. + Use -c:b (--conf:build) to specify the build context, + or -c:a (--conf:all) to specify both contexts at once. + Example: -c tools.cmake.cmaketoolchain:generator=Xcode + -c:b CONF_BUILD, --conf:build CONF_BUILD + -c:h CONF_HOST, --conf:host CONF_HOST + -c:a CONF_ALL, --conf:all CONF_ALL + -l LOCKFILE, --lockfile LOCKFILE Path to a lockfile. Use --lockfile="" to avoid automatic use of existing 'conan.lock' file - --lockfile-partial Do not raise an error if some dependency is not found + --lockfile-partial Do not raise an error if some dependency is not found in lockfile - --lockfile-out LOCKFILE_OUT + --lockfile-out LOCKFILE_OUT Filename of the updated lockfile - --lockfile-packages Lock package-id and package-revision information - --lockfile-clean Remove unused entries from the lockfile - --build-require Whether the provided reference is a build-require + --lockfile-packages Lock package-id and package-revision information + --lockfile-clean Remove unused entries from the lockfile + --lockfile-overrides LOCKFILE_OVERRIDES + Overwrite lockfile overrides + --build-require Whether the provided reference is a build-require The ``conan lock create`` command creates a lockfile for the recipe or reference specified in ``path`` or ``--requires``. This command will compute the dependency graph, evaluate which binaries do exist or need to be built, but it will diff --git a/reference/commands/profile.rst b/reference/commands/profile.rst index 32460d62a0cc..1ee23972726e 100644 --- a/reference/commands/profile.rst +++ b/reference/commands/profile.rst @@ -138,59 +138,60 @@ conan profile show .. code-block:: text $ conan profile show -h - usage: conan profile show [-h] [-f FORMAT] [-v [V]] [-o OPTIONS_HOST] - [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] - [-pr PROFILE_HOST] [-pr:b PROFILE_BUILD] - [-pr:h PROFILE_HOST] [-s SETTINGS_HOST] - [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] - [-c CONF_HOST] [-c:b CONF_BUILD] [-c:h CONF_HOST] + usage: conan profile show [-h] [-f FORMAT] [-v [V]] [-pr PROFILE] + [-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST] + [-pr:a PROFILE_ALL] [-o OPTIONS] + [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] + [-o:a OPTIONS_ALL] [-s SETTINGS] + [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] + [-s:a SETTINGS_ALL] [-c CONF] [-c:b CONF_BUILD] + [-c:h CONF_HOST] [-c:a CONF_ALL] Show aggregated profiles from the passed arguments. - optional arguments: - -h, --help show this help message and exit - -f FORMAT, --format FORMAT + options: + -h, --help show this help message and exit + -f FORMAT, --format FORMAT Select the output format: json - -v [V] Level of detail of the output. Valid options from less + -v [V] Level of detail of the output. Valid options from less verbose to more verbose: -vquiet, -verror, -vwarning, -vnotice, -vstatus, -v or -vverbose, -vv or -vdebug, -vvv or -vtrace - -o OPTIONS_HOST, --options OPTIONS_HOST - Define options values (host machine), e.g.: -o - Pkg:with_qt=true - -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD - Define options values (build machine), e.g.: -o:b - Pkg:with_qt=true - -o:h OPTIONS_HOST, --options:host OPTIONS_HOST - Define options values (host machine), e.g.: -o:h - Pkg:with_qt=true - -pr PROFILE_HOST, --profile PROFILE_HOST - Apply the specified profile to the host machine - -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD - Apply the specified profile to the build machine - -pr:h PROFILE_HOST, --profile:host PROFILE_HOST - Apply the specified profile to the host machine - -s SETTINGS_HOST, --settings SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s compiler=gcc - -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD - Settings to build the package, overwriting the - defaults (build machine). e.g.: -s:b compiler=gcc - -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s:h compiler=gcc - -c CONF_HOST, --conf CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c - tools.cmake.cmaketoolchain:generator=Xcode - -c:b CONF_BUILD, --conf:build CONF_BUILD - Configuration to build the package, overwriting the - defaults (build machine). e.g.: -c:b - tools.cmake.cmaketoolchain:generator=Xcode - -c:h CONF_HOST, --conf:host CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c:h - tools.cmake.cmaketoolchain:generator=Xcode + -pr PROFILE, --profile PROFILE + Apply the specified profile. By default, or if + specifying -pr:h (--profile:host), it applies to the + host context. Use -pr:b (--profile:build) to specify + the build context, or -pr:a (--profile:all) to specify + both contexts at once + -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD + -pr:h PROFILE_HOST, --profile:host PROFILE_HOST + -pr:a PROFILE_ALL, --profile:all PROFILE_ALL + -o OPTIONS, --options OPTIONS + Apply the specified options. By default, or if + specifying -o:h (--options:host), it applies to the + host context. Use -o:b (--options:build) to specify + the build context, or -o:a (--options:all) to specify + both contexts at once. Example: -o pkg:with_qt=true + -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD + -o:h OPTIONS_HOST, --options:host OPTIONS_HOST + -o:a OPTIONS_ALL, --options:all OPTIONS_ALL + -s SETTINGS, --settings SETTINGS + Apply the specified settings. By default, or if + specifying -s:h (--settings:host), it applies to the + host context. Use -s:b (--settings:build) to specify + the build context, or -s:a (--settings:all) to specify + both contexts at once. Example: -s compiler=gcc + -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD + -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST + -s:a SETTINGS_ALL, --settings:all SETTINGS_ALL + -c CONF, --conf CONF Apply the specified conf. By default, or if specifying + -c:h (--conf:host), it applies to the host context. + Use -c:b (--conf:build) to specify the build context, + or -c:a (--conf:all) to specify both contexts at once. + Example: -c tools.cmake.cmaketoolchain:generator=Xcode + -c:b CONF_BUILD, --conf:build CONF_BUILD + -c:h CONF_HOST, --conf:host CONF_HOST + -c:a CONF_ALL, --conf:all CONF_ALL Use :command:`conan profile show` to compute the resulting build and host profiles from the command line arguments. For example, combining different options and settings with the diff --git a/reference/commands/test.rst b/reference/commands/test.rst index ead164d67274..b0b8e3859045 100644 --- a/reference/commands/test.rst +++ b/reference/commands/test.rst @@ -7,15 +7,16 @@ conan test $ conan test -h usage: conan test [-h] [-v [V]] [-f FORMAT] [-b BUILD] [-r REMOTE | -nr] [-u] - [-o OPTIONS_HOST] [-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST] - [-pr PROFILE_HOST] [-pr:b PROFILE_BUILD] - [-pr:h PROFILE_HOST] [-s SETTINGS_HOST] - [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] [-c CONF_HOST] - [-c:b CONF_BUILD] [-c:h CONF_HOST] [-l LOCKFILE] - [--lockfile-partial] [--lockfile-out LOCKFILE_OUT] - [--lockfile-packages] [--lockfile-clean] - [--lockfile-overrides LOCKFILE_OVERRIDES] - path reference + [-pr PROFILE] [-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST] + [-pr:a PROFILE_ALL] [-o OPTIONS] [-o:b OPTIONS_BUILD] + [-o:h OPTIONS_HOST] [-o:a OPTIONS_ALL] [-s SETTINGS] + [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] + [-s:a SETTINGS_ALL] [-c CONF] [-c:b CONF_BUILD] + [-c:h CONF_HOST] [-c:a CONF_ALL] [-l LOCKFILE] + [--lockfile-partial] [--lockfile-out LOCKFILE_OUT] + [--lockfile-packages] [--lockfile-clean] + [--lockfile-overrides LOCKFILE_OVERRIDES] + path reference Test a package from a test_package folder. @@ -24,7 +25,7 @@ conan test conanfile.py reference Provide a package reference to test - optional arguments: + options: -h, --help show this help message and exit -v [V] Level of detail of the output. Valid options from less verbose to more verbose: -vquiet, -verror, -vwarning, @@ -38,7 +39,7 @@ conan test line is allowed. Possible values: --build="*" Force build from source for all packages. --build=never Disallow build for all packages, use binary packages - or fail if a binary package is not found. Cannot be + or fail if a binary package is not found, it cannot be combined with other '--build' options. --build=missing Build packages from source whose binary package is not found. --build=cascade Build packages from source that @@ -62,42 +63,41 @@ conan test that satisfies the range. Also, if using revisions, it will update to the latest revision for the resolved version range. - -o OPTIONS_HOST, --options OPTIONS_HOST - Define options values (host machine), e.g.: -o - Pkg:with_qt=true - -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD - Define options values (build machine), e.g.: -o:b - Pkg:with_qt=true - -o:h OPTIONS_HOST, --options:host OPTIONS_HOST - Define options values (host machine), e.g.: -o:h - Pkg:with_qt=true - -pr PROFILE_HOST, --profile PROFILE_HOST - Apply the specified profile to the host machine + -pr PROFILE, --profile PROFILE + Apply the specified profile. By default, or if + specifying -pr:h (--profile:host), it applies to the + host context. Use -pr:b (--profile:build) to specify + the build context, or -pr:a (--profile:all) to specify + both contexts at once -pr:b PROFILE_BUILD, --profile:build PROFILE_BUILD - Apply the specified profile to the build machine -pr:h PROFILE_HOST, --profile:host PROFILE_HOST - Apply the specified profile to the host machine - -s SETTINGS_HOST, --settings SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s compiler=gcc + -pr:a PROFILE_ALL, --profile:all PROFILE_ALL + -o OPTIONS, --options OPTIONS + Apply the specified options. By default, or if + specifying -o:h (--options:host), it applies to the + host context. Use -o:b (--options:build) to specify + the build context, or -o:a (--options:all) to specify + both contexts at once. Example: -o pkg:with_qt=true + -o:b OPTIONS_BUILD, --options:build OPTIONS_BUILD + -o:h OPTIONS_HOST, --options:host OPTIONS_HOST + -o:a OPTIONS_ALL, --options:all OPTIONS_ALL + -s SETTINGS, --settings SETTINGS + Apply the specified settings. By default, or if + specifying -s:h (--settings:host), it applies to the + host context. Use -s:b (--settings:build) to specify + the build context, or -s:a (--settings:all) to specify + both contexts at once. Example: -s compiler=gcc -s:b SETTINGS_BUILD, --settings:build SETTINGS_BUILD - Settings to build the package, overwriting the - defaults (build machine). e.g.: -s:b compiler=gcc -s:h SETTINGS_HOST, --settings:host SETTINGS_HOST - Settings to build the package, overwriting the - defaults (host machine). e.g.: -s:h compiler=gcc - -c CONF_HOST, --conf CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c - tools.cmake.cmaketoolchain:generator=Xcode + -s:a SETTINGS_ALL, --settings:all SETTINGS_ALL + -c CONF, --conf CONF Apply the specified conf. By default, or if specifying + -c:h (--conf:host), it applies to the host context. + Use -c:b (--conf:build) to specify the build context, + or -c:a (--conf:all) to specify both contexts at once. + Example: -c tools.cmake.cmaketoolchain:generator=Xcode -c:b CONF_BUILD, --conf:build CONF_BUILD - Configuration to build the package, overwriting the - defaults (build machine). e.g.: -c:b - tools.cmake.cmaketoolchain:generator=Xcode -c:h CONF_HOST, --conf:host CONF_HOST - Configuration to build the package, overwriting the - defaults (host machine). e.g.: -c:h - tools.cmake.cmaketoolchain:generator=Xcode + -c:a CONF_ALL, --conf:all CONF_ALL -l LOCKFILE, --lockfile LOCKFILE Path to a lockfile. Use --lockfile="" to avoid automatic use of existing 'conan.lock' file