Add descriptions to undocumented sysctls (hw, kern, vm)
Needs ReviewPublic
Actions

Authored by mhorne063_gmail.com on Feb 5 2018, 9:29 PM.

Details

Reviewers

emaste
brd

Summary

An attempt to reduce the number of sysctls in the system that are missing descriptions.

I've taken some effort to examine each of the sysctls to determine their purpose, but due
to the range and quanitity of changes some descriptions may require additional detail. Input
is appreciated from anyone with relevant knowledge.

In addition to the grammar and functional accuracy of the descriptions added, there will
undoubtedly be some sysctls that I have missed. Please feel free to mention them in the
appropriate thread and I will add those descriptions.

This patch covers low level sysctls under hw, kern and vm.
Some of the areas touched by this patch:

busdma (multiple archs)
virtual memory
sys/kern/
sys/sparc64/
sys/powerpc/
sys/x86/local_apic
geom

Diff Detail

Lint

Lint Skipped

Unit

Tests Skipped

Event Timeline

mhorne063_gmail.com created this revision.Feb 5 2018, 9:29 PM

Herald added subscribers: jhibbits, andrew. · View Herald TranscriptFeb 5 2018, 9:29 PM

kib added inline comments.Feb 5 2018, 11:09 PM

sys/x86/x86/local_apic.c
205	This is indicator of the selected mode, not an enable switch. After that, I do not see any other way to say it other than "x2APIC mode", and now the description becomes useless.
209–210	Same there. Also, the previous string was formatted stylish, Bruce wants the description to start on a new line always.
212–213	And there.

Updated some descriptions to match the desired style

mhorne063_gmail.com marked 3 inline comments as done.Feb 6 2018, 7:09 PM

mhorne063_gmail.com added inline comments.

sys/x86/x86/local_apic.c
205	I agree that the description becomes somewhat useless. However, I will keep it in simply for consistency and to reduce the possibility of confusion if a user were to think there was a greater explanation that was missing.