Skip to content

Commit

Permalink
Automatic deploy (build number 608)
Browse files Browse the repository at this point in the history
  • Loading branch information
ConanCI bot committed Feb 2, 2024
1 parent 062ae36 commit a231050
Show file tree
Hide file tree
Showing 120 changed files with 928 additions and 8,602 deletions.
126 changes: 2 additions & 124 deletions 2.0/_sources/reference/commands/build.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,130 +3,8 @@
conan build
===========

.. code-block:: text
$ conan build -h
usage: conan build [-h] [-v [V]] [--name NAME] [--version VERSION]
[--user USER] [--channel CHANNEL] [-g GENERATOR]
[-of OUTPUT_FOLDER] [-d DEPLOYER]
[--deployer-folder DEPLOYER_FOLDER] [--build-require]
[-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
Install dependencies and call the build() method.
positional arguments:
path Path to a python-based recipe file or a folder
containing a conanfile.py recipe. conanfile.txt cannot
be used with conan build.
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
conanfile
--user USER Provide a user if not specified in conanfile
--channel CHANNEL Provide a channel if not specified in conanfile
-g GENERATOR, --generator GENERATOR
Generators to use
-of OUTPUT_FOLDER, --output-folder OUTPUT_FOLDER
The root output folder for generated and build files
-d DEPLOYER, --deployer DEPLOYER
Deploy using the provided deployer to the output
folder
--deployer-folder DEPLOYER_FOLDER
Deployer output folder, base build folder by default
if not set
--build-require Whether the provided path is a build-require
-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
.. autohelp::
:command: conan build


The ``conan build`` command installs the recipe specified in ``path`` and calls its ``build()`` method.
Expand Down
125 changes: 12 additions & 113 deletions 2.0/_sources/reference/commands/cache.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,8 @@ Perform file operations in the local cache (of recipes and/or packages).
conan cache path
----------------

.. code-block:: text
$ conan cache path --help
usage: conan cache path [-h] [-v [V]] [--folder {export_source,source,build}] reference
Show the path to the Conan cache for a given reference.
positional arguments:
reference Recipe reference or Package reference
optional arguments:
-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
--folder {export_source,source,build,metadata}
Path to show. The 'build' requires a package
reference. If the argument is not passed, it shows
'exports' path for recipe references and 'package'
folder for package references.
.. autohelp::
:command: conan cache path


The ``conan cache path`` returns the path in the cache of a given reference. Depending on the reference, it
Expand Down Expand Up @@ -159,31 +140,9 @@ Again, the "build" folder will only exist if the package was built from source.
conan cache clean
-----------------

.. code-block:: text
.. autohelp::
:command: conan cache clean

$ conan cache clean -h
usage: conan cache clean [-h] [-v [V]] [-s] [-b] [-d] [-t] [-p PACKAGE_QUERY]
[pattern]
Remove non-critical folders from the cache, like source, build and/or download
(.tgz store) ones.
positional arguments:
pattern Selection pattern for references to clean
optional arguments:
-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
-s, --source Clean source folders
-b, --build Clean build folders
-d, --download Clean download folders
-t, --temp Clean temporary folders
-p PACKAGE_QUERY, --package-query PACKAGE_QUERY
Remove only the packages matching a specific query,
e.g., os=Windows AND (arch=x86 OR compiler=gcc)

This command will remove all temporary folders, along with the source, build and download folder
that Conan generates in its execution. It will do so for every matching reference passed in *pattern*,
Expand Down Expand Up @@ -224,22 +183,8 @@ unless a specific flag is supplied, in which case only the specified folders wil
conan cache check-integrity
---------------------------

.. code-block:: text
$ conan cache check-integrity --help
usage: conan cache check-integrity [-h] [-v [V]] [-p PACKAGE_QUERY] pattern
Check the integrity of the local cache for the given references
positional arguments:
pattern Selection pattern for references to check integrity for
optional arguments:
-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
-p PACKAGE_QUERY, --package-query PACKAGE_QUERY
Only the packages matching a specific query, e.g., os=Windows AND (arch=x86 OR compiler=gcc)
.. autohelp::
:command: conan cache check-integrity


The ``conan cache check-integrity`` command checks the integrity of Conan packages in the
Expand All @@ -261,18 +206,9 @@ For example, to verify the integrity of the whole Conan local cache, do:
conan cache backup-upload
-------------------------

.. code-block:: text
$ conan cache backup-upload -h
usage: conan cache backup-upload [-h] [-v [V]]
Upload all the source backups present in the cache
.. autohelp::
:command: conan cache backup-upload

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

The ``conan cache backup-upload`` will upload all source backups present in the local cache to the backup server,
(excluding those which have been fetched from the excluded urls listed in the ``core.sources:exclude_urls`` conf),
Expand All @@ -283,55 +219,18 @@ regardless of which package they belong to, if any.
conan cache save
----------------

.. code-block:: text
.. autohelp::
:command: conan cache save

$ conan cache save -h
usage: conan cache save [-h] [-f FORMAT] [-v [V]] [-l LIST] [--file FILE]
[pattern]
Get the artifacts from a package list and archive them
positional arguments:
pattern A pattern in the form
'pkg/version#revision:package_id#revision', e.g:
zlib/1.2.13:* means all binaries for zlib/1.2.13. If
revision is not specified, it is assumed latest one.
optional arguments:
-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
-l LIST, --list LIST Package list of packages to save
--file FILE Save to this tgz file

Read more in :ref:`devops_save_restore`.


conan cache restore
-------------------

.. code-block:: text
$ conan cache restore -h
usage: conan cache restore [-h] [-f FORMAT] [-v [V]] file
Put the artifacts from an archive into the cache
positional arguments:
file Path to archive to restore
optional arguments:
-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
.. autohelp::
:command: conan cache restore


Read more in :ref:`devops_save_restore`.
Loading

0 comments on commit a231050

Please sign in to comment.