git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [-SPAM-] [PATCH v2 3/6] doc: check for absence of multiple terms in each entry of desc list

From
Ramsay Jones <ramsay@ramsayjones.plus.com>
Date
Aug 5, 2025, 20:30 UTC
Message-ID
<0b6e4b7d-e294-4721-9ae1-3d10f5898276@ramsayjones.plus.com>
In-Reply-To
<5806390052b7a7cbdb8dc843bfcc24102604e2f6.1754421046.git.gitgitgadget@gmail.com>
On 05/08/2025 20:10, Jean-Noël Avila via GitGitGadget wrote:
Show 104 quoted lines
> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>
> 
> 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 <jn.avila@free.fr>
> ---
>  Documentation/Makefile                      | 10 +++++++++
>  Documentation/git-check-attr.adoc           |  3 ++-
>  Documentation/git-check-ignore.adoc         |  9 +++++---
>  Documentation/git-http-fetch.adoc           |  4 +++-
>  Documentation/lint-documentation-style.perl | 24 +++++++++++++++++++++
>  Documentation/technical/api-path-walk.adoc  |  5 ++++-
>  shared.mak                                  |  1 +
>  7 files changed, 50 insertions(+), 6 deletions(-)
>  create mode 100755 Documentation/lint-documentation-style.perl
> 
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 76a9e1d02b26..ac8a21e3015c 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -508,6 +508,15 @@ $(LINT_DOCS_DELIMITED_SECTIONS): .build/lint-docs/delimited-sections/%.ok: %.ado
>  .PHONY: lint-docs-delimited-sections
>  lint-docs-delimited-sections: $(LINT_DOCS_DELIMITED_SECTIONS)
>  
> +## Lint: Documentation style
> +LINT_DOCS_DOC_STYLE = $(patsubst %.adoc,.build/lint-docs/doc-style/%.ok,$(MAN_TXT))
> +$(LINT_DOCS_DOC_STYLE): lint-documentation-style.perl
> +$(LINT_DOCS_DOC_STYLE): .build/lint-docs/doc-style/%.ok: %.adoc
> +	$(call mkdir_p_parent_template)
> +	$(QUIET_LINT_DOCSTYLE)$(PERL_PATH) lint-documentation-style.perl $< >$@
> +.PHONY: lint-docs-doc-style
> +lint-docs-doc-style: $(LINT_DOCS_DOC_STYLE)
> +
>  lint-docs-manpages:
>  	$(QUIET_GEN)./lint-manpages.sh
>  
> @@ -537,6 +546,7 @@ lint-docs: lint-docs-gitlink
>  lint-docs: lint-docs-man-end-blurb
>  lint-docs: lint-docs-man-section-order
>  lint-docs: lint-docs-delimited-sections
> +lint-docs: lint-docs-doc-style
>  lint-docs: lint-docs-manpages
>  lint-docs: lint-docs-meson
>  
> diff --git a/Documentation/git-check-attr.adoc b/Documentation/git-check-attr.adoc
> index 503b6446574d..15a37a38e3f7 100644
> --- a/Documentation/git-check-attr.adoc
> +++ b/Documentation/git-check-attr.adoc
> @@ -19,7 +19,8 @@ For every pathname, this command will list if each attribute is 'unspecified',
>  
>  OPTIONS
>  -------
> --a, --all::
> +-a::
> +--all::
>  	List all attributes that are associated with the specified
>  	paths.  If this option is used, then 'unspecified' attributes
>  	will not be included in the output.
> diff --git a/Documentation/git-check-ignore.adoc b/Documentation/git-check-ignore.adoc
> index 3e3b4e344629..a6c6c1b6e5be 100644
> --- a/Documentation/git-check-ignore.adoc
> +++ b/Documentation/git-check-ignore.adoc
> @@ -25,11 +25,13 @@ subject to exclude rules; but see `--no-index'.
>  
>  OPTIONS
>  -------
> --q, --quiet::
> +-q::
> +--quiet::
>  	Don't output anything, just set exit status.  This is only
>  	valid with a single pathname.
>  
> --v, --verbose::
> +-v::
> +--verbose::
>  	Instead of printing the paths that are excluded, for each path
>  	that matches an exclude pattern, print the exclude pattern
>  	together with the path.  (Matching an exclude pattern usually
> @@ -49,7 +51,8 @@ linkgit:gitignore[5].
>  	below).  If `--stdin` is also given, input paths are separated
>  	with a NUL character instead of a linefeed character.
>  
> --n, --non-matching::
> +-n::
> +--non-matching::
>  	Show given paths which don't match any pattern.  This only
>  	makes sense when `--verbose` is enabled, otherwise it would
>  	not be possible to distinguish between paths which match a
> diff --git a/Documentation/git-http-fetch.adoc b/Documentation/git-http-fetch.adoc
> index 4ec7c68d3b9e..dcb05890aefd 100644
> --- a/Documentation/git-http-fetch.adoc
> +++ b/Documentation/git-http-fetch.adoc
> @@ -25,8 +25,10 @@ commit-id::
>          Either the hash or the filename under [URL]/refs/ to
>          pull.
>  
> --a, -c, -t::
> +-a::-c::
> +-t::

s/-a::-c::/-a:: -c::/ ?

ATB, Ramsay Jones

Previous: Jean-Noël Avila via GitGitGadgetNext: Jean-Noël AVILA
Message 13 of 28 in “Introduce more doc linting”
  1. 0/6 Introduce more doc lintingJean-Noël Avila via GitGitGadget, Aug 5, 2025
  2. 1/6 doc: test linkgit macros for well-formednessJean-Noël Avila via GitGitGadget, Aug 5, 2025
  3. 2/6 doc: check well-formedness of delimited sectionsJean-Noël Avila via GitGitGadget, Aug 5, 2025
  4. 3/6 doc: check for absence of multiple terms in each entry of desc listJean-Noël Avila via GitGitGadget, Aug 5, 2025
  5. 4/6 doc: check for absence of the form --[no-]parameterJean-Noël Avila via GitGitGadget, Aug 5, 2025
  6. 5/6 doc:git-for-each-ref: fix styling and typosJean-Noël Avila via GitGitGadget, Aug 5, 2025
  7. 6/6 doc lint: check that synopsis manpages have synopsis inlinesJean-Noël Avila via GitGitGadget, Aug 5, 2025
  8. Junio C HamanoAug 5, 2025
  9. 0/6 Introduce more doc lintingJean-Noël Avila via GitGitGadget, Aug 5, 2025
  10. 1/6 doc: test linkgit macros for well-formednessJean-Noël Avila via GitGitGadget, Aug 5, 2025
  11. 2/6 doc: check well-formedness of delimited sectionsJean-Noël Avila via GitGitGadget, Aug 5, 2025
  12. 3/6 doc: check for absence of multiple terms in each entry of desc listJean-Noël Avila via GitGitGadget, Aug 5, 2025
  13. Ramsay JonesAug 5, 2025
  14. Jean-Noël AVILAAug 8, 2025
  15. Collin FunkAug 6, 2025
  16. Jean-Noël AVILAAug 8, 2025
  17. 4/6 doc: check for absence of the form --[no-]parameterJean-Noël Avila via GitGitGadget, Aug 5, 2025
  18. 5/6 doc:git-for-each-ref: fix styling and typosJean-Noël Avila via GitGitGadget, Aug 5, 2025
  19. 6/6 doc lint: check that synopsis manpages have synopsis inlinesJean-Noël Avila via GitGitGadget, Aug 5, 2025
  20. 0/6 Introduce more doc lintingJean-Noël Avila via GitGitGadget, Aug 11, 2025
  21. 1/6 doc: test linkgit macros for well-formednessJean-Noël Avila via GitGitGadget, Aug 11, 2025
  22. 2/6 doc: check well-formedness of delimited sectionsJean-Noël Avila via GitGitGadget, Aug 11, 2025
  23. 3/6 doc: check for absence of multiple terms in each entry of desc listJean-Noël Avila via GitGitGadget, Aug 11, 2025
  24. 4/6 doc: check for absence of the form --[no-]parameterJean-Noël Avila via GitGitGadget, Aug 11, 2025
  25. 5/6 doc:git-for-each-ref: fix styling and typosJean-Noël Avila via GitGitGadget, Aug 11, 2025
  26. 6/6 doc lint: check that synopsis manpages have synopsis inlinesJean-Noël Avila via GitGitGadget, Aug 11, 2025
  27. Junio C HamanoAug 14, 2025
  28. Jean-Noël AVILAAug 14, 2025

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.