git: dff1ba09f747 - main - sysctl.9: put negative sense sysctl note in own paragraph
Ed Maste
emaste at FreeBSD.org
Tue Aug 17 16:11:02 UTC 2021
The branch main has been updated by emaste:
URL: https://cgit.FreeBSD.org/src/commit/?id=dff1ba09f74725bb0a0b7b8c229ed4e6665b43e6
commit dff1ba09f74725bb0a0b7b8c229ed4e6665b43e6
Author: Ed Maste <emaste at FreeBSD.org>
AuthorDate: 2021-08-17 15:58:03 +0000
Commit: Ed Maste <emaste at FreeBSD.org>
CommitDate: 2021-08-17 16:10:44 +0000
sysctl.9: put negative sense sysctl note in own paragraph
The sysctl man page cautions against negative-sense boolean sysctls
(foobar_disable), but it gets lost at the end of a large paragraph.
Move it to a separate paragraph in an attempt to make it more clear.
This man page could use a more holistic review and edit pass. This
change is simple and straightforward and I hope provides a small but
immediate benefit.
---
share/man/man9/sysctl.9 | 1 +
1 file changed, 1 insertion(+)
diff --git a/share/man/man9/sysctl.9 b/share/man/man9/sysctl.9
index bae693489c73..f2b1159e71a8 100644
--- a/share/man/man9/sysctl.9
+++ b/share/man/man9/sysctl.9
@@ -1024,6 +1024,7 @@ underscore characters, as in
Underscore characters may be omitted only if the name consists of not more
than two words, each being not longer than four characters, as in
.Va bootfile .
+.Pp
For boolean sysctls, negative logic should be totally avoided.
That is, do not use names like
.Va no_foobar
More information about the dev-commits-src-main
mailing list