Git development
 help / color / mirror / Atom feed
From: "Julia Evans" <julia@jvns.ca>
To: "Julia Evans" <gitgitgadget@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH] doc: don't require a SYNOPSIS in section 7
Date: Fri, 02 Oct 2026 14:20:47 -0400	[thread overview]
Message-ID: <01891b4b-ce04-41aa-8065-d7b88e466dbc@app.fastmail.com> (raw)
In-Reply-To: <pull.2246.git.1790957227881.gitgitgadget@gmail.com>

> +# assume the first line is formatted like 'gitglossary(7)'
> +my $firstline = <>;
> +$firstline =~ m/\((\d)\)/;
> +my $man_section_number = $1;
> +
>  my $last_was_section;
>  my @actual_order;
>  while (my $line = <>) {
> @@ -93,6 +98,8 @@ while (my $line = <>) {
> 
>  		for my $section (sort keys %SECTIONS) {
>  			next if !$SECTIONS{$section}->{required} or exists 
> $actual_sections{$section};
> +			# Synopsis is not required in section 7
> +			next if ($section eq "SYNOPSIS" && $man_section_number eq "7");
>  			report("has no required '$section' section!");
>  		}


I just realized that this script is actually supposed to be able to process multiple
files as command line arguments, and that this patch won't work for that.

I don't understand how Perl's `<>`  works when you pass multiple files as
command line arguments and that might be too much of a can of worms for me to
figure right now :/

  parent reply	other threads:[~2026-10-02 18:21 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-02 16:07 [PATCH] doc: don't require a SYNOPSIS in section 7 Julia Evans via GitGitGadget
2026-10-02 17:33 ` Junio C Hamano
2026-10-02 18:03   ` Junio C Hamano
2026-10-02 18:10     ` Julia Evans
2026-10-02 18:20 ` Julia Evans [this message]
2026-10-02 21:34   ` Junio C Hamano
2026-10-03  7:33     ` Tuomas Ahola
2026-10-03 11:37       ` Julia Evans
2026-10-03 12:55         ` Tuomas Ahola
2026-10-03 13:10 ` [PATCH v2] " Julia Evans via GitGitGadget
2026-10-04 13:17   ` Junio C Hamano
2026-10-06 11:17     ` Julia Evans
2026-10-06 16:07       ` Junio C Hamano
2026-10-06 16:54 ` [PATCH v3] " Julia Evans via GitGitGadget
2026-10-06 20:40   ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=01891b4b-ce04-41aa-8065-d7b88e466dbc@app.fastmail.com \
    --to=julia@jvns.ca \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox