hier(7): improvement, modernisation #763
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
|
Am I blind? I only see capitalizing in this PR |
|
You're not blind :-) it's a draft … |
Aim for better vertical alignment; and for consistent use of one empty paragraph before, and after, each intended block.
<https://man.freebsd.org/cgi/man.cgi?query=ex&sektion=1&manpath=freebsd-release> for ex(1) presents a page that is headed VI(1), so we may as well refer to vi(1).
/usr/share/misc/ is not limited to ASCII text files.
For consistency, remove a full stop.
PPP for Point-to-Point Protocol.
grahamperrin
commented
Jun 5, 2023
/usr/share/misc/fonts/ lacks a description. The trio of question marks ??? appeared twenty-seven years ago <freebsd@2641f58>. The phrase 'misc/fonts' appears only in the ports tree, nowhere in doc or src. I think we can reasonably de-list this part of the hierarchy.
The empty paragraph between /usr/include/ and /usr/lib/ is unnecessary.
Add an empty paragraph between the indented block for freebsd-update/ and the less indented block for empty/
Further attention to alignment of indented blocks.
This comment was marked as outdated.
This comment was marked as outdated.
mhorne
reviewed
Jun 6, 2023
That's a fair summary. Never more than one blank line. In a nutshell: where I found the spacing used in parts (not all) of the current edition, I did find it much easier to read. So I used the same approach to spacing throughout the page, in its entirety. Maybe easiest to see the difference with these two eighty-column windows. The window to the right is what's drafted, with extra spacing:
Now, I see that word pre-fab. Not ideal. I'll take this PR back to draft for a few more tweaks. |
Be less verbose, more technical. For calendar files at /usr/share/calendar, use the terminology that's used in the manual page for calendar(1).
As in a previous commit, describe single-user and multi-user as modes. Use rc(8) and rc.conf(5) as points of reference to help differentiate the multiple meanings of temporary.
mhorne
approved these changes
Jun 8, 2023
This comment was marked as resolved.
This comment was marked as resolved.
Resolve freebsd#763 (review) in line with the suggestion from @mhorne
freebsd-git
pushed a commit
that referenced
this pull request
Jun 10, 2023
Consistent use of lowercase, spacing between sections, etc. Cease mentioning floppy disks. De-list /usr/share/misc/fonts/, which has been ??? (without a description) for twenty-seven years. Change zpool to pool. (zpool is a command.) Uppercase PPP for Point-to-Point Protocol. A few other changes to wording, including avoidance of the phrase pre-fab. Update the descriptions of: * /tmp/ * /usr/share/misc/ * /var/preserve/ * /var/tmp/ * /var/tmp/vi.recover/. Refer to vi(1) instead of ex(1). https://bugs.freebsd.org/261349 PR: 261349 Reviewed by: mhorne Approved by: mhorne Pull request: #763
freebsd-git
pushed a commit
that referenced
this pull request
Jul 7, 2023
Consistent use of lowercase, spacing between sections, etc. Cease mentioning floppy disks. De-list /usr/share/misc/fonts/, which has been ??? (without a description) for twenty-seven years. Change zpool to pool. (zpool is a command.) Uppercase PPP for Point-to-Point Protocol. A few other changes to wording, including avoidance of the phrase pre-fab. Update the descriptions of: * /tmp/ * /usr/share/misc/ * /var/preserve/ * /var/tmp/ * /var/tmp/vi.recover/. Refer to vi(1) instead of ex(1). https://bugs.freebsd.org/261349 PR: 261349 Reviewed by: mhorne Approved by: mhorne Pull request: #763 (cherry picked from commit 6469f9c) (cherry picked from commit 5ca7f02) (cherry picked from commit b374a39)
bsdjhb
pushed a commit
to bsdjhb/cheribsd
that referenced
this pull request
Aug 14, 2023
Consistent use of lowercase, spacing between sections, etc. Cease mentioning floppy disks. De-list /usr/share/misc/fonts/, which has been ??? (without a description) for twenty-seven years. Change zpool to pool. (zpool is a command.) Uppercase PPP for Point-to-Point Protocol. A few other changes to wording, including avoidance of the phrase pre-fab. Update the descriptions of: * /tmp/ * /usr/share/misc/ * /var/preserve/ * /var/tmp/ * /var/tmp/vi.recover/. Refer to vi(1) instead of ex(1). https://bugs.freebsd.org/261349 PR: 261349 Reviewed by: mhorne Approved by: mhorne Pull request: freebsd/freebsd-src#763
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.
hier(7): improvement, modernisation
Consistent use of lowercase, spacing between sections, etc.
Cease mentioning floppy disks.
De-list /usr/share/misc/fonts/, which has been ??? (without a description) for twenty-seven years.
Change zpool to pool.
Uppercase PPP for Point-to-Point Protocol.
A few other improvements to wording, including avoidance of the phrase pre-fab.
Update the descriptions of:
Refer to vi(1) instead of ex(1).
https://bugs.freebsd.org/261349
PR: 261349
Pull request: #763
The 30th May edition, rendered: https://reviews.freebsd.org/paste/raw/572/