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.

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

Improve '--update' docstring #7167

Merged
merged 3 commits into from Jul 24, 2020
Merged

Conversation

jgsogo
Copy link
Member

@jgsogo jgsogo commented Jun 9, 2020

Changelog: Feature: More detailed description for --update argument.
Docs: conan-io/docs#1778

This flag appears in many commands: test, create, install, info, workspace, graph lock

close #7146

@jgsogo jgsogo requested a review from memsharded Jun 9, 2020
conans/client/command.py Outdated Show resolved Hide resolved
@jgsogo jgsogo added this to the 1.27 milestone Jun 9, 2020
@jgsogo jgsogo added the component: ux No changes to core business logic label Jun 9, 2020
@jgsogo jgsogo marked this pull request as draft Jun 9, 2020
@memsharded memsharded modified the milestones: 1.27, 1.28 Jun 28, 2020
@czoido
Copy link
Contributor

@czoido czoido commented Jul 23, 2020

I think that part of the confusing behaviour of the --update argument is when it is used with version ranges and revisions at the same time and also that are some commands that are meant to install the new packages in the local cache and other that just want to check if there's a new version. Also there was a bug reported using --update that could also make it less evident.

I think that the docstring for this argument could be something like this for: test, create, install, workspace, graph lock

"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, when using revisions, it will update to the latest revision for the resolved version range."

and for info:

"Will check if updates of the dependencies exist in the remotes (a new version that satisfies a version range, a new revision or a newer recipe if not using revisions)."

Would it make sense with the behaviour we want for --update @memsharded ?

The issue that originated this PR maybe could be an effect of a bug reported with conan graph lock and --update: #7333

@czoido czoido marked this pull request as ready for review Jul 24, 2020
@czoido czoido requested review from memsharded and danimtb Jul 24, 2020
@czoido czoido merged commit a3703e8 into conan-io:develop Jul 24, 2020
2 checks passed
@jgsogo jgsogo deleted the fix/update-helpstring branch Aug 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: ux No changes to core business logic
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants