Skip to content

Commit 8ec5c19

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 16c9380 commit 8ec5c19

File tree

6 files changed

+26
-6
lines changed

6 files changed

+26
-6
lines changed

Documentation/Makefile

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,15 @@ $(LINT_DOCS_DELIMITED_SECTIONS): .build/lint-docs/delimited-sections/%.ok: %.ado
508508
.PHONY: lint-docs-delimited-sections
509509
lint-docs-delimited-sections: $(LINT_DOCS_DELIMITED_SECTIONS)
510510

511+
## Lint: Documentation style
512+
LINT_DOCS_DOC_STYLE = $(patsubst %.adoc,.build/lint-docs/doc-style/%.ok,$(MAN_TXT))
513+
$(LINT_DOCS_DOC_STYLE): lint-documentation-style.perl
514+
$(LINT_DOCS_DOC_STYLE): .build/lint-docs/doc-style/%.ok: %.adoc
515+
$(call mkdir_p_parent_template)
516+
$(QUIET_LINT_DOCSTYLE)$(PERL_PATH) lint-documentation-style.perl $< >$@
517+
.PHONY: lint-docs-doc-style
518+
lint-docs-doc-style: $(LINT_DOCS_DOC_STYLE)
519+
511520
lint-docs-manpages:
512521
$(QUIET_GEN)./lint-manpages.sh
513522

@@ -537,6 +546,7 @@ lint-docs: lint-docs-gitlink
537546
lint-docs: lint-docs-man-end-blurb
538547
lint-docs: lint-docs-man-section-order
539548
lint-docs: lint-docs-delimited-sections
549+
lint-docs: lint-docs-doc-style
540550
lint-docs: lint-docs-manpages
541551
lint-docs: lint-docs-meson
542552

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

shared.mak

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ ifndef V
8989
QUIET_LINT_GITLINK = @echo ' ' LINT GITLINK $<;
9090
QUIET_LINT_MANSEC = @echo ' ' LINT MAN SEC $<;
9191
QUIET_LINT_DELIMSEC = @echo ' ' LINT DEL SEC $<;
92+
QUIET_LINT_DOCSTYLE = @echo ' ' LINT DOCSTYLE $<;
9293
QUIET_LINT_MANEND = @echo ' ' LINT MAN END $<;
9394

9495
export V

0 commit comments

Comments
 (0)