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

From: Junio C Hamano <gitster@pobox.com>
Date: Oct 2, 2026, 18:03 UTC
Message-ID: <xmqq7bk0vv38.fsf@gitster.g>
In-Reply-To: <xmqqv77kvwgr.fsf@gitster.g>

Junio C Hamano <gitster@pobox.com> writes:

Show 15 quoted lines

> diff --git c/Documentation/lint-man-section-order.perl w/Documentation/lint-man-section-order.perl
> index 02408a0062..ce60c34809 100755
> --- c/Documentation/lint-man-section-order.perl
> +++ w/Documentation/lint-man-section-order.perl
> @@ -55,8 +55,23 @@ sub report {
>  
>  my $last_was_section;
>  my @actual_order;
> +my $section_tweak_done;
>  while (my $line = <>) {
>  	chomp $line;
> +
> +	if (!$section_tweak_done) {
> +		# assume the first line is formatted like 'gitglossary(7)'
> +		my $firstline = <>;

Ah, this was obviously buggy.  Not <>, but we should use $line here.

Show 13 quoted lines

> +		$firstline =~ m/\((\d)\)/;
> +		my $man_section_number = $1;
> +
> +		if ($man_section_number == "7") {
> +			# section 7 usually do not have SYNOPSIS
> +			$SECTIONS{SYNOPSIS}{required} = 0;
> +		}
> +		$section_tweak_done = 1;
> +	}
> +
>  	if ($line =~ $SECTION_RX) {
>  		push @actual_order => $line;
>  		$last_was_section = 1;