admin/git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc lint: check that synopsis manpages have synopsis inlines

Browse Source 
When switching manpages to the synopsis style, the description lists of
options need to be switched to inline synopsis for proper formatting. This
is done by enclosing the option name in double backticks, e.g. `--option`.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jean-Noël Avila
2025-08-11 20:53:20 +00:00
committed by Junio C Hamano
parent 93203872d7
commit 84f3d6e11e
3 changed files with 17 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/lint-documentation-style.perl
View File

@@ -21,6 +21,12 @@ while (my $line = <>) {
if ($line =~ /^`?--\[no-\][a-z0-9-]+.*(::|;;)$/) {
report($line, "definition list item with a `--[no-]` parameter");
}
if ($line =~ /^\[synopsis\]$/) {
$synopsis_style = 1;
}
if (($line =~ /^(-[-a-z].*|<[-a-z0-9]+>(\.{3})?)(::|;;)$/) && ($synopsis_style)) {
report($line, "synopsis style and definition list item not backquoted");
}
}