Remove redundante variable docs from README #681
Merged
Conversation
This file contains hidden or 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
While at it, make semantics of setting the variable more accurate: it needs to be set before the *tar* completion is sourced (not bash_completion), and it needs to be set to a non-null value.
They are largely duplicating what we have in doc/bash_completion.txt, and inaccurate in saying the vars can be set to anything -- they need to be set to a non-null value.
|
Maybe we can change the extension of |
akinomyoga
approved these changes
Jan 5, 2022
|
Yup, either that, or change all docs to markdown. Markdown covers our needs fine, and more people are familiar with it than with asciidoc. |
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.
While working on #678, I noticed we have some redundant and inaccurate descriptions in README for some variables. I'm sure some of these are not FAQ's these days any more either.
This removes the redundant descriptions from README, moves it elsewhere for
tar, and generally makes the info a bit less scattered. I think we should make the main README.md even smaller going forward, but that's something for another PR.