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.

Sign up for GitHub

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

Jump to bottom

Various minor improvements/fixes to the manpages #17140

Closed
wants to merge 7 commits into from
Closed

Various minor improvements/fixes to the manpages #17140

wants to merge 7 commits into from

Conversation

fragglet
Copy link
Contributor

@fragglet fragglet commented Mar 12, 2025 •
edited
Loading

This makes a number of minor improvements to the manpages: some are more nitpicky language changes but others are unambiguously spelling mistakes / errors.

How Has This Been Tested?

No code changes, only trivial documentation fixes.

Types of changes

  • 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)
  • Library ABI change (libzfs, libzfs_core, libnvpair, libuutil and libzfsbootenv)
  • [ x ] Documentation (a change to man pages or other documentation)

Checklist:

  • [ x ] My code follows the OpenZFS code style requirements.
  • I have updated the documentation accordingly.
  • [ x ] I have read the contributing document.
  • I have added tests to cover my changes.
  • I have run the ZFS Test Suite with this change applied.
  • [ x ] All commit messages are properly formatted and contain Signed-off-by.

fragglet added 3 commits March 12, 2025 20:19
@fragglet
Harmonize on American spelling in several places
7fd9aed 
Most of the documentation is written in American English, so it makes
sense to be consistent.

Signed-off-by: Simon Howard <fraggle@gmail.com>
@fragglet
Make use of "i.e." (id est) consistent
517d8e2 
This is the most common way it is written throughout the manpages, but
there are a few cases where it is written slightly differently.

Signed-off-by: Simon Howard <fraggle@gmail.com>
@fragglet
Fix cases where "descendent" is used as a noun
3bbcebd 
As per Wiktionary: "descendent" may be used as an adjective (e.g.
"a descendent dataset") but for nouns (e.g. "descendants of this
dataset"), "descendant" is the correct spelling.

Signed-off-by: Simon Howard <fraggle@gmail.com>
@fragglet fragglet changed the title Fix various minor spelling mistakes in the manual pages Various minor improvements/fixes to the manpages Mar 12, 2025
fragglet added 4 commits March 13, 2025 02:30
@fragglet
Capitalize in various places where appropriate
07f76e4 
These are mostly acronyms (CPUs; ZILs) but also proper nouns such as
"Unix" and "Unicode" which should also be capitalized.

Signed-off-by: Simon Howard <fraggle@gmail.com>
@fragglet
Correct "umount" to "unmount" in a couple of places
8fdc032 
This is admittedly a nitpicky change, but `umount` is the command that
performs an *unmount*. So if we are talking about unmounting something
we should phrase it that way.

Signed-off-by: Simon Howard <fraggle@gmail.com>
@fragglet
Fix spelling errors
668beac 
Unlike some of my other fixes which are more subtle, these are
unambigously spelling errors.

Signed-off-by: Simon Howard <fraggle@gmail.com>
@fragglet
Disambiguate reference to kibibytes, not kilobytes
f060175 
A minor nitpick that is kind of obvious based on the surrounding context
and reference to powers of two. It's better to be explicit, though.

Signed-off-by: Simon Howard <fraggle@gmail.com>
tonyhutter
tonyhutter approved these changes Mar 18, 2025
View reviewed changes
Copy link
Contributor

@tonyhutter tonyhutter left a comment

Choose a reason for hiding this comment

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

Thanks for this cleanup 👍

@tonyhutter tonyhutter added Type: Documentation Indicates a requested change to the documentation Status: Code Review Needed Ready for review and testing labels Mar 18, 2025
@fragglet
Copy link
Contributor Author

Do you need anything from me to merge this PR? The failing tests look like they're flaky tests - there are no code changes here.

amotin
amotin approved these changes Mar 24, 2025
View reviewed changes
Copy link
Member

@amotin amotin left a comment

Choose a reason for hiding this comment

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

I am not a native speaker to review this, but as I can see many of the changes are US vs British. Grammar wars are the last thing we need. ;)

@fragglet
Copy link
Contributor Author

Only one of the commits is related to British vs. American spelling. I'm British myself but figure it's best to harmonize on one set of spellings rather than a mishmash of both.

@tonyhutter
Copy link
Contributor

Merged as:
fd01824 Disambiguate reference to kibibytes, not kilobytes
ef81812 Fix spelling errors
e759a86 Correct "umount" to "unmount" in a couple of places
1d4505d Capitalize in various places where appropriate
b386bf8 Fix cases where "descendent" is used as a noun
73494f3 Make use of "i.e." (id est) consistent
530ddcd Harmonize on American spelling in several places

@tonyhutter tonyhutter closed this Mar 24, 2025
@fragglet
Copy link
Contributor Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@amotin amotin amotin approved these changes

@tonyhutter tonyhutter tonyhutter approved these changes

Assignees
No one assigned
Labels
Status: Code Review Needed Ready for review and testing Type: Documentation Indicates a requested change to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fragglet @tonyhutter @amotin