Page MenuHomeFreeBSD
Differential D28914

Add zero_region.9 manual page
ClosedPublic
Actions

Authored by khng on Feb 24 2021, 5:02 PM.
Tags
None
Referenced Files
F133253108: D28914.id84621.diff
Fri, Oct 24, 8:47 AM
Unknown Object (File)
Wed, Oct 22, 2:24 AM
Unknown Object (File)
Sun, Oct 19, 7:49 PM
Unknown Object (File)
Sun, Oct 19, 5:45 PM
Unknown Object (File)
Sat, Oct 18, 5:14 PM
Unknown Object (File)
Thu, Oct 16, 7:59 AM
Unknown Object (File)
Mon, Oct 13, 2:32 AM
Unknown Object (File)
Mon, Oct 13, 2:32 AM
View All Files
Subscribers
gbe
imp
markj
philip
Contributor Reviews (src)

Details

Reviewers
ygy
lwhsu
alc
gbe
philip
Group Reviewers
manpages
Commits
rG43afeee2fbf9: share/man/man9: document zero_region(9)
Summary

zero_region lacks documentation currently. A manual page is proposed for
zero_region and ZERO_REGION_SIZE to describe what it is.

Submitted by: Ka Ho Ng <khng@freebsdfoundation.org>
Sponsored by: The FreeBSD Foundation

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 37480
Build 34369: arc lint + arc unit

Event Timeline

khng created this revision.Feb 24 2021, 5:02 PM
Herald added a reviewer: manpages. · View Herald TranscriptFeb 24 2021, 5:02 PM
Herald added subscribers: Contributor Reviews (src), imp. · View Herald Transcript
khng requested review of this revision.Feb 24 2021, 5:02 PM
Harbormaster completed remote builds in B37346: Diff 84614.Feb 24 2021, 5:02 PM
khng added a child revision: D28915: systm.h: Correct comment on zero_region.Feb 24 2021, 5:03 PM
khng added reviewers: ygy, lwhsu, alc.Feb 24 2021, 5:05 PM
khng updated this revision to Diff 84619.Feb 24 2021, 5:21 PM

Forgot to add manpage to share/man/man9/Makefile

Harbormaster completed remote builds in B37351: Diff 84619.Feb 24 2021, 5:21 PM
gbe accepted this revision.Feb 24 2021, 6:35 PM
gbe added a subscriber: gbe.

LGTM from manpages . Did you run igor and 'mandoc -Tlint' against the man page?

This revision is now accepted and ready to land.Feb 24 2021, 6:35 PM
khng updated this revision to Diff 84621.Feb 24 2021, 6:51 PM

Reorder SEE ALSO section to fix mandoc -T lint warning.

This revision now requires review to proceed.Feb 24 2021, 6:51 PM
Harbormaster completed remote builds in B37352: Diff 84621.Feb 24 2021, 6:52 PM
khng added a comment.EditedFeb 24 2021, 6:53 PM
In D28914#647282, @gbe wrote:

LGTM from manpages . Did you run igor and 'mandoc -Tlint' against the man page?

I just checked it against mandoc -Tlint, and did some fixes.

The output from mandoc -Tlint in the current form is:

mandoc: share/man/man9/zero_region.9:80:28: STYLE: consider using OS macro: Fx

The output of igor is:

$ igor -R share/man/man9/zero_region.9
zero_region.9:28:date not today, February 25, 2021:.Dd February 24, 2021
gbe accepted this revision.Feb 24 2021, 7:15 PM
In D28914#647311, @khng300_gmail.com wrote:
In D28914#647282, @gbe wrote:

LGTM from manpages . Did you run igor and 'mandoc -Tlint' against the man page?

I just checked it against mandoc -Tlint, and did some fixes.

The output from mandoc -Tlint in the current form is:

mandoc: share/man/man9/zero_region.9:80:28: STYLE: consider using OS macro: Fx

The output of igor is:

$ igor -R share/man/man9/zero_region.9
zero_region.9:28:date not today, February 25, 2021:.Dd February 24, 2021

Minor issues, still LGTM.

Thanks for contributing this manual page.

This revision is now accepted and ready to land.Feb 24 2021, 7:15 PM
lwhsu added inline comments.Feb 25 2021, 2:23 AM
share/man/man9/zero_region.9
27

do we still need to have $FreeBSD$ in newly added file?

imp added inline comments.Feb 25 2021, 2:35 AM
share/man/man9/zero_region.9
27

If this will be MFC to 12, then yes. Otherwise no.

khng added a comment.Feb 25 2021, 2:58 AM

This could be MFCed, as zero_region is from FreeBSD 9 era.

khng updated this revision to Diff 84646.Feb 25 2021, 5:47 AM

Add a line in description to tell developers not to make an assumption.

This revision now requires review to proceed.Feb 25 2021, 5:47 AM
Harbormaster completed remote builds in B37362: Diff 84646.Feb 25 2021, 5:47 AM
khng updated this revision to Diff 84648.Feb 25 2021, 7:44 AM

Move the last paragraph in DESCRIPTION section to CAVEATS section.

Harbormaster completed remote builds in B37363: Diff 84648.Feb 25 2021, 7:44 AM
ygy accepted this revision.Feb 25 2021, 8:30 AM
This revision is now accepted and ready to land.Feb 25 2021, 8:30 AM
markj added a subscriber: markj.Mar 1 2021, 4:36 PM
markj added inline comments.
share/man/man9/zero_region.9
50

It would be useful to write a couple of sentences explaining what exactly the example is doing.

59

Note that the exclusive lock is not strictly required by VOP_WRITE. Since vnode locking is not really relevant to the example, I would just omit the assertion.

85

Are you referring to the fact that the zero region is the same 4KB page mapped multiple times (on amd64 at least)? Why is it a caveat? IMPLEMENTATION NOTES is more suitable IMO.

khng updated this revision to Diff 84909.Mar 1 2021, 4:52 PM

Updates with markj@'s suggestions.

This revision now requires review to proceed.Mar 1 2021, 4:52 PM
khng marked 3 inline comments as done.Mar 1 2021, 4:52 PM
Harbormaster completed remote builds in B37480: Diff 84909.Mar 1 2021, 4:52 PM
khng marked 2 inline comments as done.Mar 1 2021, 4:53 PM
philip accepted this revision.Mar 2 2021, 9:11 AM
philip added a subscriber: philip.

Looks good to me. I'll go and commit this now.

This revision is now accepted and ready to land.Mar 2 2021, 9:11 AM
Closed by commit rG43afeee2fbf9: share/man/man9: document zero_region(9) (authored by khng, committed by philip). · Explain WhyMar 2 2021, 9:21 AM
This revision was automatically updated to reflect the committed changes.
philip added a commit: rG43afeee2fbf9: share/man/man9: document zero_region(9).

Revision Contents
Changeset List

PathSize
share/
man/
man9/
1 line
86 lines

Diff 84909

View Options

share/man/man9/Makefile

Loading...
View Options

share/man/man9/zero_region.9

Loading...