Skip to content

pr-2246/jvns/no-synopsis-v2

tagged this 03 Oct 13:10
From: Julia Evans <julia@jvns.ca>

Remove the SYNOPSIS section from the section 7 man pages where
appropriate, to avoid having a section that contains no information.
It's not the norm in section 7 to always require a SYNOPSIS.

Update the perl script with a special case for section 7.

Tested by running `make lint-docs`, and looked at the renaming synopses
with this fish script snippet:

for i in *.7
   echo $i; grep SYNOPSIS -A 5 (string replace .7 .adoc $i)
end

Co-authored-by: Tuomas Ahola <taahol@utu.fi>
Signed-off-by: Tuomas Ahola <taahol@utu.fi>
Signed-off-by: Julia Evans <julia@jvns.ca>

Submitted-As: https://lore.kernel.org/git/pull.2246.v2.git.1791033057232.gitgitgadget@gmail.com
In-Reply-To: https://lore.kernel.org/git/pull.2246.git.1790957227881.gitgitgadget@gmail.com
Assets 2
Loading