Tutorial for local flow #2968
Merged
Tutorial for local flow #2968
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
memsharded
approved these changes
Feb 15, 2023
tutorial/developing_packages/local_package_development_flow.rst
Outdated
Show resolved
Hide resolved
tutorial/developing_packages/local_package_development_flow.rst
Outdated
Show resolved
Hide resolved
tutorial/developing_packages/local_package_development_flow.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: James <james@conan.io>
SSE4
suggested changes
Feb 15, 2023
| Download (without install) a single conan package from a remote server. | ||
|
|
||
| It downloads just the package, but not its transitive dependencies, and it will not call | ||
| any generate, generators or deployers. |
There was a problem hiding this comment.
generate and generators? a typo, perhaps?
| -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 | ||
| --logger Show the output with log format, with time, type and message. |
There was a problem hiding this comment.
it outputs in json format, is it expected?
conan download --logger -r conancenter zlib/1.2.11
{"json": {"level": "STATUS", "time": "2023-02-15T15:53:56.822022+00:00", "data": "Downloading recipe 'zlib/1.2.11#ffa77daf83a57094149707928bdce823'"}}
{"json": {"level": "STATUS", "time": "2023-02-15T15:53:59.592272+00:00", "data": "Downloading conan_export.tgz"}}
{"json": {"level": "STATUS", "time": "2023-02-15T15:53:59.602051+00:00", "data": "Downloading conanmanifest.txt"}}
{"json": {"level": "STATUS", "time": "2023-02-15T15:53:59.604367+00:00", "data": "Downloading conanfile.py"}}
{"json": {"level": "STATUS", "time": "2023-02-15T15:53:59.984767+00:00", "data": "Decompressing conan_export.tgz"}}
{"json": {"level": "STATUS", "time": "2023-02-15T15:53:59.988140+00:00", "data": "Downloading 'zlib/1.2.11' sources"}}
{"json": {"level": "STATUS", "time": "2023-02-15T15:54:00.474447+00:00", "data": "Downloading conan_sources.tgz"}}
{"json": {"level": "STATUS", "time": "2023-02-15T15:54:00.475827+00:00", "data": "Decompressing conan_sources.tgz"}}
{"json": {"level": "STATUS", "time": "2023-02-15T15:54:00.476446+00:00", "data": "Sources downloaded from 'conancenter'"}}
also, it could be better to specify what is time (is it local, UTC, what's the format)
| [-s:b SETTINGS_BUILD] [-s:h SETTINGS_HOST] [-c CONF_HOST] [-c:b CONF_BUILD] [-c:h CONF_HOST] | ||
| path | ||
|
|
||
| Create a package directly from pre-compiled binaries |
There was a problem hiding this comment.
Suggested change
| Create a package directly from pre-compiled binaries | |
| Creates a package directly from pre-compiled binaries |
| $ conan download --help | ||
| usage: conan download [-h] [-v [V]] [--logger] [--only-recipe] [-p PACKAGE_QUERY] -r REMOTE reference | ||
|
|
||
| Download (without install) a single conan package from a remote server. |
There was a problem hiding this comment.
Suggested change
| Download (without install) a single conan package from a remote server. | |
| Downloads (without install) a single conan package from a remote server. |
|
|
||
| positional arguments: | ||
| {add,list,remove} sub-command help | ||
| add Define the given <path> location as the package <reference>, so when this package is required, it is |
There was a problem hiding this comment.
it's a bit unclear how and where do I specify path and reference
| --lockfile-packages Lock package-id and package-revision information | ||
| --lockfile-clean remove unused | ||
| -o OPTIONS_HOST, --options OPTIONS_HOST | ||
| Define options values (host machine), e.g.: -o Pkg:with_qt=true |
There was a problem hiding this comment.
it doesn't work, as options format has changed in v2:
conan export-pkg . --version 1.2.11 -o zlib:shared=True
Using lockfile: '/home/sse4/projects/conan-center-index/recipes/zlib/all/conan.lock'
ERROR: Error while initializing options. The usage of package names `zlib:shared` in options is deprecated, use a pattern like `zlib/*` or `zlib*` instead
| -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 |
There was a problem hiding this comment.
I think it specifies both host and build at the same time per conan-io/tribe#23
|
|
||
| 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. |
|
|
||
| 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. |
There was a problem hiding this comment.
also, what's the effect of calling conan source on conanfile.txt? it doesn't have a source method, right?
There was a problem hiding this comment.
This is and the rest are just copy&paste from the --help of the commands. We will check all of them in the conan repo in case something needs changes but they can't be addressed in this one.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
And also placeholders for some missing commands
Examples: conan-io/examples2#72