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

2
Documentation/git-checkout.adoc
View File

@@ -334,7 +334,7 @@ include::diff-context-options.adoc[]
separated with _NUL_ character and all other characters are taken separated with _NUL_ character and all other characters are taken
literally (including newlines and quotes). literally (including newlines and quotes).
<branch>:: `<branch>`::
Branch to checkout; if it refers to a branch (i.e., a name that, Branch to checkout; if it refers to a branch (i.e., a name that,
when prepended with "refs/heads/", is a valid ref), then that when prepended with "refs/heads/", is a valid ref), then that
branch is checked out. Otherwise, if it refers to a valid branch is checked out. Otherwise, if it refers to a valid

20
Documentation/git-refs.adoc
View File

@@ -20,41 +20,41 @@ This command provides low-level access to refs.
COMMANDS COMMANDS
-------- --------
migrate:: `migrate`::
Migrate ref store between different formats. Migrate ref store between different formats.
verify:: `verify`::
Verify reference database consistency. Verify reference database consistency.
OPTIONS OPTIONS
------- -------
The following options are specific to 'git refs migrate': The following options are specific to `git refs migrate`:
--ref-format=<format>:: `--ref-format=<format>`::
The ref format to migrate the ref store to. Can be one of: The ref format to migrate the ref store to. Can be one of:
+ +
include::ref-storage-format.adoc[] include::ref-storage-format.adoc[]
--dry-run:: `--dry-run`::
Perform the migration, but do not modify the repository. The migrated Perform the migration, but do not modify the repository. The migrated
refs will be written into a separate directory that can be inspected refs will be written into a separate directory that can be inspected
separately. The name of the directory will be reported on stdout. This separately. The name of the directory will be reported on stdout. This
can be used to double check that the migration works as expected before can be used to double check that the migration works as expected before
performing the actual migration. performing the actual migration.
--reflog:: `--reflog`::
--no-reflog:: `--no-reflog`::
Choose between migrating the reflog data to the new backend, Choose between migrating the reflog data to the new backend,
and discarding them. The default is "--reflog", to migrate. and discarding them. The default is "--reflog", to migrate.
The following options are specific to 'git refs verify': The following options are specific to `git refs verify`:
--strict:: `--strict`::
Enable stricter error checking. This will cause warnings to be Enable stricter error checking. This will cause warnings to be
reported as errors. See linkgit:git-fsck[1]. reported as errors. See linkgit:git-fsck[1].
--verbose:: `--verbose`::
When verifying the reference database consistency, be chatty. When verifying the reference database consistency, be chatty.
KNOWN LIMITATIONS KNOWN LIMITATIONS

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

@@ -21,6 +21,12 @@ while (my $line = <>) {
if ($line =~ /^`?--\[no-\][a-z0-9-]+.*(::|;;)$/) { if ($line =~ /^`?--\[no-\][a-z0-9-]+.*(::|;;)$/) {
report($line, "definition list item with a `--[no-]` parameter"); 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");
}
} }