aboutsummaryrefslogtreecommitdiff
path: root/sys/dev/netmap/netmap.c
diff options
context:
space:
mode:
authorAlexander Ziaee <ziaee@FreeBSD.org>2026-03-02 10:24:11 +0000
committerAlexander Ziaee <ziaee@FreeBSD.org>2026-04-10 18:28:50 +0000
commit7f30d5cd3373205bcc5411d671de9e4a5ae9941d (patch)
tree76ce77bb516485214e6cdd028f24bbdd863b28dd /sys/dev/netmap/netmap.c
parent906f2745bd842cba8c017ae2fe7e7f18a64f3c44 (diff)
style.mdoc: Remove synopsis formatting advice
Remove incorrect advice. The first rule was no spaces padding pipes when showing alternates. Almost universally we not do this, and third party manuals do not either. The second was using Cm to mark up symbols. This advice is in conflict with mdoc(7), and the extended documentation on mdoc linked below, which is also linked at the bottom of mdoc(7). Conflicting information in our docs is a natural result of documentation proliferation. The most important thing we can do to reduce technical debt in the documentation is reduce the amount of doc overlap. Excessive technical debt and conflicting rules is a barrier to new contributors. This type of work requires thorough expertise, is not glamorous at all, and to add insult to injury, is socially unsafe. To get new contributors to the docs project, we must deduplicate documentation. We have the mdoc manual, examples/mdoc, style.mdoc, and the fdp chapter on manual pages. With this many, they will inevitably come to contain conflicting information, and people will learn not to read them or work on them. MFC after: 3 days Ref: https://mandoc.bsd.lv/mdoc/style/commands.html Differential Revision: https://reviews.freebsd.org/D55298 (cherry picked from commit 47326cb470278e891975354286481b5ba876929a)
Diffstat (limited to 'sys/dev/netmap/netmap.c')
0 files changed, 0 insertions, 0 deletions