Page MenuHomeFreeBSD

Add many sysctl descriptions in kern
ClosedPublic

Authored by antranigv_freebsd.am on Feb 19 2020, 5:39 PM.

Details

Reviewers
kaktus
Group Reviewers
docs
Commits
rS358548: sys/: Document few more sysctls.

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

sys/kern/kern_exec.c
135 ↗(On Diff #68547)

Use style(9) similar to the entry before, the documentation string should be in a separate line, using proper indentation of 4 spaces.

sys/kern/kern_shutdown.c
170 ↗(On Diff #68547)

This should be four spaces and doc sting in a new line.

sys/kern/kern_synch.c
98 ↗(On Diff #68547)

Here too.

sys/kern/sched_4bsd.c
438 ↗(On Diff #68547)

And too.

sys/kern/sched_ule.c
3130 ↗(On Diff #68547)

And too.

sys/kern/subr_kobj.c
71 ↗(On Diff #68547)

And too :-)

jhb added inline comments.
sys/kern/kern_exec.c
135 ↗(On Diff #68547)

Perhaps "Stack memory permissions". This has the same value as the "prot" argument to mmap (bitmask of PROT_* constants), and the description of "prot" in mmap(2) is "permissions"

127 ↗(On Diff #68577)

Perhaps "Location of process' ps_strings structure"

132 ↗(On Diff #68577)

Perhaps "Top of process stack" (usrstack is the top, not the bottom of the stack, and even then we store various things on the stack such as argv[] and environment arrays before the actual stack used by main())

sys/kern/kern_synch.c
98 ↗(On Diff #68547)

Might be nice to say what it is used for? I think it might be the scaling factor used for load average values, but haven't looked to see how userland (e.g. top or ps) uses this.

sys/kern/kern_umtx.c
243 ↗(On Diff #68577)

s/Maximal/Maximum/? maybe s/one/each/ as well

antranigv_freebsd.am marked 4 inline comments as done.

addressing jhb's comments

This revision is now accepted and ready to land.Mar 2 2020, 3:28 PM
This revision was automatically updated to reflect the committed changes.