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

cli: config: add docs for --show-origin #2028

Merged
merged 4 commits into from
Feb 4, 2021

Conversation

mrstegeman
Copy link
Contributor

@mrstegeman mrstegeman commented Dec 17, 2020

Support the --show-origin option for config, which, similar to git,
prefixes each config option with the source file it originated from.

Per iterative/dvc#5119
Matches iterative/dvc#5126

You may disregard these recommendations if you used the Edit on GitHub button from dvc.org to improve a doc in place.

❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.

🐛 Please make sure to mention Fix #issue (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

Please choose to allow us to edit your branch when creating the PR.

Thank you for the contribution - we'll try to review it as soon as possible. 🙏

@shcheklein shcheklein added the ⌛ status: wait-core-merge Waiting for related product PR merge/release label Dec 18, 2020
@jorgeorpinel
Copy link
Contributor

I think that it would be great to mention the option somewhere in the description around where the config file location tables are — probably as a note (md block quote).

@mrstegeman
Copy link
Contributor Author

I think that it would be great to mention the option somewhere in the description around where the config file location tables are — probably as a note (md block quote).

Done.

Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woah that was fast. Thanks @mrstegeman! LGTM

Support the --show-origin option for config, which, similar to git,
prefixes each config option with the source file it originated from.

References iterative/dvc#5119
References iterative/dvc#5126
mrstegeman added a commit to mrstegeman/dvc that referenced this pull request Dec 31, 2020
Builds on iterative#5126 and iterative#5184 by showing the full merged config when
listing or getting config options.

References iterative#5126
References iterative#5184
References iterative/dvc.org#2028
Fixes iterative#5119
efiop added a commit to iterative/dvc that referenced this pull request Jan 4, 2021
* cli: config: show merged config with --show-origin

Builds on #5126 and #5184 by showing the full merged config when
listing or getting config options.

References #5126
References #5184
References iterative/dvc.org#2028
Fixes #5119

* Add additional tests.

* Add test for merged config.

* config: rename methods

Co-authored-by: OLOLO ALALA <[email protected]>
@shcheklein shcheklein merged commit 7b303fc into iterative:master Feb 4, 2021
@mrstegeman mrstegeman deleted the show-origin branch February 4, 2021 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⌛ status: wait-core-merge Waiting for related product PR merge/release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants