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

[build-order] Added --order xxx parameter #3552

Merged
merged 1 commit into from
Jan 30, 2024
Merged

[build-order] Added --order xxx parameter #3552

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
198 changes: 101 additions & 97 deletions reference/commands/graph/build_order.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ conan graph build-order
[--lockfile-out LOCKFILE_OUT]
[--lockfile-clean]
[--lockfile-overrides LOCKFILE_OVERRIDES]
[--order {recipe,configuration}]
[path]

Compute the build order of a dependency graph.
Expand Down Expand Up @@ -120,105 +121,108 @@ conan graph build-order
--lockfile-clean Remove unused entries from the lockfile
--lockfile-overrides LOCKFILE_OVERRIDES
Overwrite lockfile overrides
--order {recipe,configuration}
Select how to order the output, "recipe" by default if not set.

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.
The ``conan graph build-order`` command computes build order of the dependency graph for the recipe specified in ``path``.

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
-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-clean Remove unused entries from the lockfile
--lockfile-overrides LOCKFILE_OVERRIDES
Overwrite lockfile overrides

**Example**:

Let's think of installing `libpng`, and we want to see the build order for this requirement:

.. code-block:: text

$ conan graph build-order --requires libpng/1.5.30 --format json
...
======== Computing the build order ========
[
[
{
"ref": "zlib/1.3#5c0f3a1a222eebb6bff34980bcd3e024",
"depends": [],
"packages": [
[
{
"package_id": "be7ccd6109b8a8f9da81fd00ee143a1f5bbd5bbf",
"prev": null,
"context": "host",
"binary": "Missing",
"options": [],
"filenames": [],
"depends": [],
"overrides": {},
"build_args": null
}
]
]
}
],
[
{
"ref": "libpng/1.5.30#ed8593b3f837c6c9aa766f231c917a5b",
"depends": [
"zlib/1.3#5c0f3a1a222eebb6bff34980bcd3e024"
],
"packages": [
[
{
"package_id": "235f6d8c648e7c618d86155a8c3c6efb96d61fa1",
"prev": null,
"context": "host",
"binary": "Missing",
"options": [],
"filenames": [],
"depends": [],
"overrides": {},
"build_args": null
}
]
]
}
]
]

At first place, we can see the ``zlib`` package as ``libpng`` depends on it. That output is ordered by recipes by default, but
we could want to see it ordered by configurations instead:

.. code-block:: text

The ``conan graph build-order`` command computes build order of the dependency graph for the recipe specified in ``path``.
$ conan graph build-order --requires libpng/1.5.30 --format json --order configuration
...
======== Computing the build order ========
[
[
{
"ref": "zlib/1.3#5c0f3a1a222eebb6bff34980bcd3e024",
"pref": "zlib/1.3#5c0f3a1a222eebb6bff34980bcd3e024:be7ccd6109b8a8f9da81fd00ee143a1f5bbd5bbf",
"package_id": "be7ccd6109b8a8f9da81fd00ee143a1f5bbd5bbf",
"prev": null,
"context": "host",
"binary": "Missing",
"options": [],
"filenames": [],
"depends": [],
"overrides": {},
"build_args": null
}
],
[
{
"ref": "libpng/1.5.30#ed8593b3f837c6c9aa766f231c917a5b",
"pref": "libpng/1.5.30#ed8593b3f837c6c9aa766f231c917a5b:235f6d8c648e7c618d86155a8c3c6efb96d61fa1",
"package_id": "235f6d8c648e7c618d86155a8c3c6efb96d61fa1",
"prev": null,
"context": "host",
"binary": "Missing",
"options": [],
"filenames": [],
"depends": [
"zlib/1.3#5c0f3a1a222eebb6bff34980bcd3e024:be7ccd6109b8a8f9da81fd00ee143a1f5bbd5bbf"
],
"overrides": {},
"build_args": null
}
]
]