Man pages: zpool/zfs get parameters are optional #7914
Closed
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
### Motivation and Context The 'pool' parameter for `zpool get` and the 'dataset' parameter for `zfs get` are optional, but the man pages listed them as mandatory. ### Description Marked the (man zpool: get) pool and (man zfs: get) dataset parameter as optional. ### How Has This Been Tested? ### Types of changes - [X] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Performance enhancement (non-breaking change which improves efficiency) - [ ] Code cleanup (non-breaking change which makes code smaller or more readable) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [X] Documentation (a change to man pages or other documentation) ### Checklist: - [ ] My code follows the ZFS on Linux [code style requirements](https://github.com/zfsonlinux/zfs/blob/master/.github/CONTRIBUTING.md#coding-conventions). - [X] I have updated the documentation accordingly. - [X] I have read the [**contributing** document](https://github.com/zfsonlinux/zfs/blob/master/.github/CONTRIBUTING.md). - [ ] I have added [tests](https://github.com/zfsonlinux/zfs/tree/master/tests) to cover my changes. - [ ] All new and existing tests passed. - [ ] All commit messages are properly formatted and contain [`Signed-off-by`](https://github.com/zfsonlinux/zfs/blob/master/.github/CONTRIBUTING.md#signed-off-by). - [ ] Change has been approved by a ZFS on Linux member. Signed-off-by: Gregor Kopka <gregor@kopka.net>
13 tasks
|
I find it a bit silly that the template for the pull request description dosn't seem to be compatible with the buildbot STYLE check (lines to long). Cut down the title and the description. |
The template is for the pull request itself, not for the commit(s). |
|
Well then... time for me to start from scratch, isn't it? |
|
@behlendorf could the linking from #7912 to here be a typo? |
|
@GregorKopka yes, sorry about that I made a typo which accidentally linked it. |
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.
Motivation and Context
The 'pool' parameter for
zpool getand the 'dataset' parameter forzfs getare optional, but the man pages listed them as mandatory.Description
Marked the parameters in the respective man pages as optional to make
them reflect the actual behaviour.
Signed-off-by: Gregor Kopka gregor@kopka.net