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.

Sign up for GitHub

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

conan build reference #3383

Merged
merged 1 commit into from
Sep 15, 2023
Merged

conan build reference #3383

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 18 additions & 4 deletions reference/commands/build.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ conan build

$ conan build -h
usage: conan build [-h] [-v [V]] [--name NAME] [--version VERSION]
[--user USER] [--channel CHANNEL] [-of OUTPUT_FOLDER]
[--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]
[-pr:b PROFILE_BUILD] [-pr:h PROFILE_HOST]
Expand All @@ -16,6 +18,7 @@ conan build
[-c:h CONF_HOST] [-l LOCKFILE] [--lockfile-partial]
[--lockfile-out LOCKFILE_OUT] [--lockfile-packages]
[--lockfile-clean]
[--lockfile-overrides LOCKFILE_OVERRIDES]
[path]

Install dependencies and call the build() method.
Expand All @@ -36,22 +39,31 @@ conan build
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. 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.
Expand Down Expand Up @@ -113,9 +125,11 @@ conan build
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


The ``conan build`` command installs the recipe specified in ``path`` and calls its ``build`` method.
The ``conan build`` command installs the recipe specified in ``path`` and calls its ``build()`` method.

.. seealso::

Expand Down