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

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

On Thu, Apr 07 2022, Todd Zullinger wrote:

> Hi Ævar,
>
> Ævar Arnfjörð Bjarmason wrote:
>> 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;
>
> Excellent, thanks!  I had run the lint-docs-gitlink target
> to see if it reported any issue, but it hadn't.  With this,
> prior to the change I made to git-update-index.txt, it
> properly reports the issue:
>
>     make -C Documentation/ lint-docs-gitlink
>     ...
> 	LINT GITLINK git-update-index.txt
>     git-update-index.txt:531: error: git-fsmonitor--daemon[1]: should link '--' as '{litdd}'), shown with 'HERE' below:
>     git-update-index.txt:531:	'linkgit:git-fsmonitor--daemon[1]' <-- HERE
>     make: *** [Makefile:442: .build/lint-docs/gitlink/git-update-index.ok] Error 1
>     make: *** Deleting file '.build/lint-docs/gitlink/git-update-index.ok'
>     make: Leaving directory '/src/git/Documentation'

Yup, note that it'll find the other one(s) too if you pass the "-k" flag
to make, i.e. it's erroring out and aborting on the first error (as is
make's default behavior).

It won't help with all the changes you made though, e.g. headers etc. We
could add that, but it would be bigger change. This seemed easy enough
for a proposed squash-in.

Thanks for the fix!