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

Re: [PATCH v3] doc: don't require a SYNOPSIS in section 7

From
Junio C Hamano <gitster@pobox.com>
Date
Oct 6, 2026, 20:40 UTC
Message-ID
<xmqqfqyid0l9.fsf@gitster.g>
In-Reply-To
<pull.2246.v3.git.1791305670386.gitgitgadget@gmail.com>
"Julia Evans via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 28 quoted lines
> From: Julia Evans <julia@jvns.ca>
>
> Remove the SYNOPSIS section from the section 7 man pages where
> appropriate, to avoid having a section that contains no information.
> It's not the norm in section 7 to always require a SYNOPSIS.
>
> Update the perl script with a special case for section 7.
>
> Tested by running `make lint-docs`, and looked at the renaming synopses
> with this fish script snippet:
>
> for i in *.7
>    echo $i; grep SYNOPSIS -A 5 (string replace .7 .adoc $i)
> end
>
> Co-authored-by: Tuomas Ahola <taahol@utu.fi>
> Signed-off-by: Tuomas Ahola <taahol@utu.fi>
> Signed-off-by: Julia Evans <julia@jvns.ca>
> ---
>     doc: don't require a SYNOPSIS in section 7
>     
>     Changes in v3: Make sure that $man_section_number doesn't become
>     undefined if the first line doesn't match the regex
>     
>     Tested on a file with a first line that isn't well-formatted to make
>     sure it works and got this output:
>     
>     gitdatamodel.adoc:1: first line must be formatted like 'gitfaq(7)'

And it aborts the whole thing? That does count as a lint. We are promoting the "assume the first line is ..." to require the format, which is probably a good thing to do.

Will replace.  Thanks.
Previous: Julia Evans via GitGitGadget
Message 15 of 15 in “doc: don't require a SYNOPSIS in section 7”
  1. doc: don't require a SYNOPSIS in section 7Julia Evans via GitGitGadget, Oct 2, 2026
  2. Junio C HamanoOct 2, 2026
  3. Junio C HamanoOct 2, 2026
  4. Julia EvansOct 2, 2026
  5. Julia EvansOct 2, 2026
  6. Junio C HamanoOct 2, 2026
  7. Tuomas AholaOct 3, 2026
  8. Julia EvansOct 3, 2026
  9. Tuomas AholaOct 3, 2026
  10. doc: don't require a SYNOPSIS in section 7Julia Evans via GitGitGadget, Oct 3, 2026
  11. Junio C HamanoOct 4, 2026
  12. Julia EvansOct 6, 2026
  13. Junio C HamanoOct 6, 2026
  14. doc: don't require a SYNOPSIS in section 7Julia Evans via GitGitGadget, Oct 6, 2026
  15. Junio C HamanoOct 6, 2026

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.