Skip to content

Commit

Permalink
Update commands reference section
Browse files Browse the repository at this point in the history
  • Loading branch information
@danimtb
danimtb committed Jan 18, 2021
1 parent 39a83a0 commit 935681d
Show file tree
Hide file tree
Showing 11 changed files with 85 additions and 73 deletions.
26 changes: 13 additions & 13 deletions commands_help_update.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,37 @@
import sys

folder = {
"install": "consumer",
"config": "consumer",
"get": "consumer",
"info": "consumer",
"install": "consumer",
"search": "consumer",

"new": "creator",
"create": "creator",
"export-pkg": "creator",
"upload": "creator",
"export": "creator",
"new": "creator",
"export-pkg": "creator",
"test": "creator",
"upload": "creator",

"source": "development",
"build": "development",
"package": "development",
"source": "development",
"editable": "development",
"workspace": "development",


"alias": "misc",
"copy": "misc",
"download": "misc",
"help": "misc",
"imports": "misc",
"inspect": "misc",
"profile": "misc",
"remote": "misc",
"remove": "misc",
"user": "misc",
"graph": "misc",
"imports": "misc",
"copy": "misc",
"remove": "misc",
"alias": "misc",
"download": "misc",
"inspect": "misc",
"help": "misc",
"lock": "misc",
}

experimental = ["inspect"]
Expand Down
4 changes: 2 additions & 2 deletions reference/commands/consumer/config.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ conan config

.. code-block:: bash
$ conan config [-h] {get,home,install,rm,set} ...
$ conan config [-h] {get,home,install,rm,set,init} ...
Manages Conan configuration.

Expand All @@ -19,7 +19,7 @@ Used to edit conan.conf, or install config files.
.. code-block:: text
positional arguments:
{get,home,install,rm,set}
{get,home,install,rm,set,init}
sub-command help
get Get the value of configuration item
home Retrieve the Conan home directory
Expand Down
24 changes: 13 additions & 11 deletions reference/commands/consumer/info.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ conan info
$ conan info [-h] [--paths] [-bo BUILD_ORDER] [-g GRAPH]
[-if INSTALL_FOLDER] [-j [JSON]] [-n ONLY]
[--package-filter [PACKAGE_FILTER]] [-db [DRY_BUILD]]
[-b [BUILD]] [-r REMOTE] [-u] [-l [LOCKFILE]] [-e ENV_HOST]
[-e:b ENV_BUILD] [-e:h ENV_HOST] [-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]
[-b [BUILD]] [-r REMOTE] [-u] [-l LOCKFILE]
[--lockfile-out LOCKFILE_OUT] [-e ENV_HOST] [-e:b ENV_BUILD]
[-e:h ENV_HOST] [-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]
path_or_reference
Gets information about the dependency graph of a recipe.
Expand Down Expand Up @@ -53,8 +53,9 @@ your local cache.
written
-n ONLY, --only ONLY Show only the specified fields: "id", "build_id",
"remote", "url", "license", "requires", "update",
"required", "date", "author", "description", "None". '
--paths' information can also be filtered with options
"required", "date", "author", "description",
"provides", "deprecated", "None". '--paths'
information can also be filtered with options
"export_folder", "build_folder", "package_folder",
"source_folder". Use '--only None' to show only
references.
Expand All @@ -75,9 +76,10 @@ your local cache.
remotes (a new version that satisfies a version range,
a new revision or a newer recipe if not using
revisions).
-l [LOCKFILE], --lockfile [LOCKFILE]
Path to a lockfile or folder containing 'conan.lock'
file. Lockfile can be updated if packages change
-l LOCKFILE, --lockfile LOCKFILE
Path to a lockfile
--lockfile-out LOCKFILE_OUT
Filename of the updated lockfile
-e ENV_HOST, --env ENV_HOST
Environment variables that will be set during the
package build (host machine). e.g.: -e
Expand Down
21 changes: 11 additions & 10 deletions reference/commands/consumer/install.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ conan install
$ conan install [-h] [-g GENERATOR] [-if INSTALL_FOLDER] [-m [MANIFESTS]]
[-mi [MANIFESTS_INTERACTIVE]] [-v [VERIFY]]
[--no-imports] [-j JSON] [-b [BUILD]] [-r REMOTE] [-u]
[-l [LOCKFILE]] [--lockfile-out LOCKFILE_OUT] [-e ENV_HOST] [-e:b ENV_BUILD]
[-e:h ENV_HOST] [-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]
[-l LOCKFILE] [--lockfile-out LOCKFILE_OUT] [-e ENV_HOST]
[-e:b ENV_BUILD] [-e:h ENV_HOST] [-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]
[--lockfile-node-id LOCKFILE_NODE_ID]
path_or_reference [reference]
Expand Down Expand Up @@ -94,9 +94,10 @@ generators.
that satisfies the range. Also, if using revisions, it
will update to the latest revision for the resolved
version range.
-l [LOCKFILE], --lockfile [LOCKFILE]
Path to a lockfile or folder containing 'conan.lock'
file. Lockfile can be updated if packages change
-l LOCKFILE, --lockfile LOCKFILE
Path to a lockfile
--lockfile-out LOCKFILE_OUT
Filename of the updated lockfile
-e ENV_HOST, --env ENV_HOST
Environment variables that will be set during the
package build (host machine). e.g.: -e
Expand Down Expand Up @@ -134,7 +135,7 @@ generators.
Settings to build the package, overwriting the
defaults (host machine). e.g.: -s:h compiler=gcc
--lockfile-node-id LOCKFILE_NODE_ID
NodeID of the referenced package in the lockfile
NodeID of the referenced package in the lockfile
:command:`conan install` executes methods of a *conanfile.py* in the following order:
Expand Down
10 changes: 6 additions & 4 deletions reference/commands/creator/create.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ conan create
$ conan create [-h] [-j JSON] [-k] [-kb] [-ne] [-tbf TEST_BUILD_FOLDER]
[-tf TEST_FOLDER] [--ignore-dirty] [-m [MANIFESTS]]
[-mi [MANIFESTS_INTERACTIVE]] [-v [VERIFY]] [-b [BUILD]]
[-r REMOTE] [-u] [-l [LOCKFILE]] [-e ENV_HOST]
[-r REMOTE] [-u] [-l LOCKFILE]
[--lockfile-out LOCKFILE_OUT] [-e ENV_HOST]
[-e:b ENV_BUILD] [-e:h ENV_HOST] [-o OPTIONS_HOST]
[-o:b OPTIONS_BUILD] [-o:h OPTIONS_HOST]
[-pr PROFILE_HOST] [-pr:b PROFILE_BUILD]
Expand Down Expand Up @@ -99,9 +100,10 @@ to know more about 'test_folder' project.
that satisfies the range. Also, if using revisions, it
will update to the latest revision for the resolved
version range.
-l [LOCKFILE], --lockfile [LOCKFILE]
Path to a lockfile or folder containing 'conan.lock'
file. Lockfile can be updated if packages change
-l LOCKFILE, --lockfile LOCKFILE
Path to a lockfile
--lockfile-out LOCKFILE_OUT
Filename of the updated lockfile
-e ENV_HOST, --env ENV_HOST
Environment variables that will be set during the
package build (host machine). e.g.: -e
Expand Down
21 changes: 11 additions & 10 deletions reference/commands/creator/export-pkg.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ conan export-pkg
$ conan export-pkg [-h] [-bf BUILD_FOLDER] [-f] [-if INSTALL_FOLDER]
[-pf PACKAGE_FOLDER] [-sf SOURCE_FOLDER] [-j JSON]
[-l [LOCKFILE]] [--ignore-dirty] [-e ENV_HOST]
[-e:b ENV_BUILD] [-e:h ENV_HOST] [-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]
[-l LOCKFILE] [--lockfile-out LOCKFILE_OUT]
[--ignore-dirty] [-e ENV_HOST] [-e:b ENV_BUILD]
[-e:h ENV_HOST] [-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]
path [reference]
Exports a recipe, then creates a package from local source and build folders.
Expand Down Expand Up @@ -54,10 +55,10 @@ the binary package.
directory can also be specified
-j JSON, --json JSON Path to a json file where the install information will
be written
-l [LOCKFILE], --lockfile [LOCKFILE]
Path to a lockfile or folder containing 'conan.lock'
file. Lockfile will be updated with the exported
package
-l LOCKFILE, --lockfile LOCKFILE
Path to a lockfile.
--lockfile-out LOCKFILE_OUT
Filename of the updated lockfile
--ignore-dirty When using the "scm" feature with "auto" values,
capture the revision and url even if there are
uncommitted changes
Expand Down
13 changes: 7 additions & 6 deletions reference/commands/creator/export.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ conan export

.. code-block:: bash
$ conan export [-h] [-k] [-l [LOCKFILE]] [--ignore-dirty]
$ conan export [-h] [-k] [-l LOCKFILE] [--lockfile-out LOCKFILE_OUT]
[--ignore-dirty]
path [reference]
Copies the recipe (conanfile.py & associated files) to your local cache.
Expand All @@ -21,7 +22,7 @@ to any remote with the 'conan upload' command.
path Path to a folder containing a conanfile.py or to a
recipe file e.g., my_folder/conanfile.py
reference user/channel, Pkg/version@user/channel (if name and
version are not declared in the conanfile.py) or
version are not declared in the conanfile.py)
Pkg/version@ if user/channel is not relevant.
optional arguments:
Expand All @@ -30,10 +31,10 @@ to any remote with the 'conan upload' command.
Do not remove the source folder in the local cache,
even if the recipe changed. Use this for testing
purposes only
-l [LOCKFILE], --lockfile [LOCKFILE]
Path to a lockfile or folder containing 'conan.lock'
file. Lockfile will be updated with the exported
package
-l LOCKFILE, --lockfile LOCKFILE
Path to a lockfile file.
--lockfile-out LOCKFILE_OUT
Filename of the updated lockfile
--ignore-dirty When using the "scm" feature with "auto" values,
capture the revision and url even if there are
uncommitted changes
Expand Down
3 changes: 1 addition & 2 deletions reference/commands/creator/new.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ Creates a new package recipe template with a 'conanfile.py' and optionally,
method. Useful in combination with "export-pkg"
command
-m TEMPLATE, --template TEMPLATE
Use the given template from the local cache for
conanfile.py
Use the given template to generate a conan project
-cis, --ci-shared Package will have a "shared" option to be used in CI
-cilg, --ci-travis-gcc
Generate travis-ci files for linux gcc
Expand Down
20 changes: 11 additions & 9 deletions reference/commands/creator/test.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ conan test
.. code-block:: bash
$ conan test [-h] [-tbf TEST_BUILD_FOLDER] [-b [BUILD]] [-r REMOTE] [-u]
[-l [LOCKFILE]] [-e ENV_HOST] [-e:b ENV_BUILD]
[-e:h ENV_HOST] [-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]
[-l LOCKFILE] [--lockfile-out LOCKFILE_OUT] [-e ENV_HOST]
[-e:b ENV_BUILD] [-e:h ENV_HOST] [-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]
path reference
Tests a package consuming it from a conanfile.py with a test() method.
Expand All @@ -26,7 +27,7 @@ to be tested must exist in the local cache or any configured remote.
positional arguments:
path Path to the "testing" folder containing a conanfile.py
or to a recipe file with test() methode.g. conan
or to a recipe file with test() method e.g. conan
test_package/conanfile.py pkg/version@user/channel
reference pkg/version@user/channel of the package to be tested
Expand Down Expand Up @@ -66,9 +67,10 @@ to be tested must exist in the local cache or any configured remote.
that satisfies the range. Also, if using revisions, it
will update to the latest revision for the resolved
version range.
-l [LOCKFILE], --lockfile [LOCKFILE]
Path to a lockfile or folder containing 'conan.lock'
file. Lockfile can be updated if packages change
-l LOCKFILE, --lockfile LOCKFILE
Path to a lockfile
--lockfile-out LOCKFILE_OUT
Filename of the updated lockfile
-e ENV_HOST, --env ENV_HOST
Environment variables that will be set during the
package build (host machine). e.g.: -e
Expand Down
14 changes: 9 additions & 5 deletions reference/commands/misc/lock.rst
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _conan_lock:

conan lock
===========
==========

.. code-block:: bash
Expand All @@ -12,16 +12,20 @@ Generates and manipulates lock files.
.. code-block:: text
positional arguments:
{update,build-order,clean-modified,create}
{update,build-order,clean-modified,create}
sub-command help
update Complete missing information in the first lockfile with information defined in the second lockfile. Both lockfiles must represent the same graph,
and have the same topology with the same identifiers, i.e. the second lockfile must be an evolution based on the first one
update Complete missing information in the first lockfile
with information defined in the second lockfile. Both
lockfiles must represent the same graph, and have the
same topology with the same identifiers, i.e. the
second lockfile must be an evolution based on the
first one
build-order Returns build-order
clean-modified Clean modified flags
create Create a lockfile from a conanfile or a reference
optional arguments:
-h, --help show this help message and exit
-h, --help show this help message and exit
Expand Down
2 changes: 1 addition & 1 deletion reference/commands/misc/remove.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ by default in the local conan cache.
-f, --force Remove without requesting a confirmation
-l, --locks Remove locks
-o, --outdated Remove only outdated from recipe packages. This flag
can only be used with a reference
can only be used with a pattern or a reference
-p [PACKAGES [PACKAGES ...]], --packages [PACKAGES [PACKAGES ...]]
Remove all packages of the specified reference if no
specific package ID is provided
Expand Down

0 comments on commit 935681d

Please sign in to comment.