-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Minor improvements to zpoolconcepts.7 #14726
Conversation
* Fixed one typo (effects -> affects) * Re-worded raidz description to make it clearer that it is not quite the same as RAID5, though similar * Clarified that data is not necessarily written in a static stripe width * Minor grammar consistency improvement * Noted that "volumes" means zvols * Fixed a couple of split infinitives * Clarified that hot spares come from the same pool they were assigned to * "we" -> ZFS Signed-off-by: Brandon Thetford <[email protected]>
Minor documentation update to the zpoolconcepts.7 man page. There was also an instance of "can not" that I changed to "cannot," as those two terms have subtly different meaning, and "cannot" was the intended meaning. "Can not" can be interpreted to mean that something is possible to not be done. "Cannot" unambiguously means that it is impossible to do that thing. |
Fixed warnings thrown by mandoc, and removed unnecessary wordiness in one fixed line. Signed-off-by: Brandon Thetford <[email protected]>
Why improper and important? Not a native speaker, but looking at Oxford dictionary, it seems "effects", used as a verb, is perfectly fine here. |
"Effects" actually makes little to no sense in that sentence, as used. "Effects," as a verb, means "causes" or "creates." The intent of that sentence is to say that it alters the capacity and IOPS. "Affects" is the appropriate word for that usage. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for making a pass over this. Generally looks good to me aside from my one DRAID comment.
* Fixed one typo (effects -> affects) * Re-worded raidz description to make it clearer that it is not quite the same as RAID5, though similar * Clarified that data is not necessarily written in a static stripe width * Minor grammar consistency improvement * Noted that "volumes" means zvols * Fixed a couple of split infinitives * Clarified that hot spares come from the same pool they were assigned to * "we" -> ZFS * Fixed warnings thrown by mandoc, and removed unnecessary wordiness in one fixed line. Reviewed-by: Brian Behlendorf <[email protected]> Signed-off-by: Brandon Thetford <[email protected]> Closes openzfs#14726
Mostly grammatical consistency/fixes for zpoolconcepts.7, and some minor clarification.
Motivation and Context
I noticed incorrect use of "effects" when looking at the man page and decided to include some other minor improvements to grammar, clarity, and consistency while I was fixing that.
Description
How Has This Been Tested?
Documentation changes only. No code changes.
Types of changes
Checklist:
Signed-off-by
]