Merge branch 'dk/replay-doc-omit-irrelevant-rev-list-options' into jch

Documentation clean-up.

The tip "fix-up" commit need to be reviewed for "make -C Documentation lint-docs"

* dk/replay-doc-omit-irrelevant-rev-list-options:
  lint-gitlink: preemptively ignore all /ifn?def|endif/ macros
  replay: drop rev-list formatting options from manual
This commit is contained in:
Junio C Hamano 2026-01-21 08:31:12 -08:00
commit f87e65a202
3 changed files with 5 additions and 3 deletions

View File

@ -64,6 +64,7 @@ The default mode can be configured via the `replay.refAction` configuration vari
range should have a single tip, so that it's clear to which tip the
advanced <branch> should point.
:git-replay: 1
include::rev-list-options.adoc[]
[[output]]

View File

@ -41,10 +41,11 @@ die "BUG: No list of valid linkgit:* files given" unless @ARGV;
@ARGV = $to_check;
while (<>) {
my $line = $_;
next if $line =~ /^\s*(ifn?def|endif)::/;
while ($line =~ m/(.{,8})((git[-a-z]+|scalar)\[(\d)*\])/g) {
my $pos = pos $line;
my ($macro, $target, $page, $section) = ($1, $2, $3, $4);
if ( $macro ne "linkgit:" && $macro !~ "ifn?def::" && $macro ne "endif::" ) {
if ( $macro ne "linkgit:" ) {
report($pos, $line, $target, "linkgit: macro expected");
}
}

View File

@ -1096,7 +1096,7 @@ endif::git-rev-list[]
Overrides a previous `--no-walk`.
endif::git-shortlog[]
ifndef::git-shortlog[]
ifndef::git-shortlog,git-replay[]
Commit Formatting
~~~~~~~~~~~~~~~~~
@ -1265,4 +1265,4 @@ ifdef::git-rev-list[]
counts and print the count for equivalent commits separated
by a tab.
endif::git-rev-list[]
endif::git-shortlog[]
endif::git-shortlog,git-replay[]