Page MenuHomeFreeBSD

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

Authored by mhorne063_gmail.com on Feb 5 2018, 9:29 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Apr 7, 12:48 AM
Unknown Object (File)
Sat, Apr 6, 3:06 PM
Unknown Object (File)
Feb 25 2024, 4:33 PM
Unknown Object (File)
Dec 23 2023, 10:31 AM
Unknown Object (File)
Dec 13 2023, 12:08 AM
Unknown Object (File)
Nov 25 2023, 3:33 AM
Unknown Object (File)
Nov 22 2023, 8:46 PM
Unknown Object (File)
Nov 22 2023, 2:36 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

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 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.