Skip to content

Commit e4756de

Browse files
committed
doc: check for absence of multiple terms in each entry of desc list
Due to portability issues, the script generate-configlist.sh was fixed to not use carriage returns in the output. However, the result is that it no longer correctly handles multiple terms in a single entry of the definition list. We now check that these entries do not exist in the documentation. Signed-off-by: Jean-Noël Avila <[email protected]>
1 parent 0cd2c38 commit e4756de

File tree

5 files changed

+20
-6
lines changed

5 files changed

+20
-6
lines changed

Documentation/git-check-attr.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ For every pathname, this command will list if each attribute is 'unspecified',
1919

2020
OPTIONS
2121
-------
22-
-a, --all::
22+
-a::
23+
--all::
2324
List all attributes that are associated with the specified
2425
paths. If this option is used, then 'unspecified' attributes
2526
will not be included in the output.

Documentation/git-check-ignore.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,13 @@ subject to exclude rules; but see `--no-index'.
2525

2626
OPTIONS
2727
-------
28-
-q, --quiet::
28+
-q::
29+
--quiet::
2930
Don't output anything, just set exit status. This is only
3031
valid with a single pathname.
3132

32-
-v, --verbose::
33+
-v::
34+
--verbose::
3335
Instead of printing the paths that are excluded, for each path
3436
that matches an exclude pattern, print the exclude pattern
3537
together with the path. (Matching an exclude pattern usually
@@ -49,7 +51,8 @@ linkgit:gitignore[5].
4951
below). If `--stdin` is also given, input paths are separated
5052
with a NUL character instead of a linefeed character.
5153

52-
-n, --non-matching::
54+
-n::
55+
--non-matching::
5356
Show given paths which don't match any pattern. This only
5457
makes sense when `--verbose` is enabled, otherwise it would
5558
not be possible to distinguish between paths which match a

Documentation/git-http-fetch.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,10 @@ commit-id::
2525
Either the hash or the filename under [URL]/refs/ to
2626
pull.
2727

28-
-a, -c, -t::
28+
-a::-c::
29+
-t::
2930
These options are ignored for historical reasons.
31+
3032
-v::
3133
Report what is downloaded.
3234

Documentation/technical/api-path-walk.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@ It is also important that you do not specify the `--objects` flag for the
3939
the objects will be walked in a separate way based on those starting
4040
commits.
4141

42-
`commits`, `blobs`, `trees`, `tags`::
42+
`commits`::
43+
`blobs`::
44+
`trees`::
45+
`tags`::
4346
By default, these members are enabled and signal that the path-walk
4447
API should call the `path_fn` on objects of these types. Specialized
4548
applications could disable some options to make it simpler to walk

t/t0451-well-formed-doc.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,9 @@ END { if (in_section) {print \"section not finished in \" FILENAME;}}
5151
test_must_be_empty out
5252
'
5353

54+
test_expect_success 'no multiple parameters in definition list items' '
55+
(cd $GIT_BUILD_DIR && git grep -Er '\''^[ \t]*`?[-a-z0-9.]+`?(, `?[-a-z0-9.]+`?)+(::|;;)$'\'' -- '\''Documentation/**.adoc'\'' || true) > out &&
56+
test_must_be_empty out
57+
'
58+
5459
test_done

0 commit comments

Comments
 (0)