Man page updates #5842
Merged
Man page updates #5842
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
When registering an option and setting a metavar, and then later adding a command line option, the metavar will get reset (to None) if one is not given again. Let's respect the previously set metavar, if one exists. As an example where this manifests, the "--show" option of the "avocado" command line option, currently lacks a metavar even with one being set for the setting itself. Signed-off-by: Cleber Rosa <[email protected]>
Signed-off-by: Cleber Rosa <[email protected]>
This updates the man page to cover all current commands, and its options. Signed-off-by: Cleber Rosa <[email protected]>
Instead of having documentation only on the man page, or duplicated that will often bitrot, let's have most of it in the main documentation section. In the case of the distro plugin, the only documentation available was on the man page, which is very often not consulted by users. Signed-off-by: Cleber Rosa <[email protected]>
Wrapper support was removed back in d4b365a. Let's sync the man page. Signed-off-by: Cleber Rosa <[email protected]>
There are a number of small differences between the behavior and output depicted in the man page and the current status. This syncs them all. Signed-off-by: Cleber Rosa <[email protected]>
|
Dear contributor,
As for the Avocado utility modules (“avocado.utils”) it is OK to introduce new functionality, |
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.
This is a collection of updates to the man page in preparation for the 103.0 LTS release.
Fixes: #5050