Re: [PATCH] doc: replace "--" with {litdd} in credential-cache/fsmonitor

From

Ævar Arnfjörð Bjarmason <avarab@gmail.com>

Date

Apr 7, 2022, 17:23 UTC

Message-ID

<220407.86h774dcyk.gmgdl@evledraar.gmail.com>

In-Reply-To

<20220406184122.4126898-1-tmz@pobox.com>

On Wed, Apr 06 2022, Todd Zullinger wrote:

> Asciidoc renders `--` as em-dash.  This is not appropriate for command
> names.  It also breaks linkgit links to these commands.

Looks good, for the linkgit case let's check it in "make check-docs":

diff --git a/Documentation/lint-gitlink.perl b/Documentation/lint-gitlink.perl
index 1c61dd9512b..2f46b261282 100755
--- a/Documentation/lint-gitlink.perl
+++ b/Documentation/lint-gitlink.perl
@@ -46,6 +46,7 @@ sub report {
 		my ($target, $page, $section) = ($1, $2, $3);
 
 		# De-AsciiDoc
+		my $raw_page = $page;
 		$page =~ s/{litdd}/--/g;
 
 		if (!exists $TXT{$page}) {
@@ -61,6 +62,7 @@ sub report {
 			report($pos, $line, $target, "wrong section (should be $real_section)");
 			next;
 		}
+		report($pos, $line, $target, "should link '--' as '{litdd}')") if $raw_page =~ /--/;
 	}
 	# this resets our $. for each file
 	close ARGV if eof;