Re: [PATCH 1/2] pull doc: refer to a specific section in 'fetch' doc

From: Philippe Blain <levraiphilippeblain@gmail.com>
Date: Apr 16, 2020, 12:39 UTC
Message-ID: <0099CBAF-983E-46F2-B7E9-D5E661189587@gmail.com>
In-Reply-To: <20200406201945.GA1245278@coredump.intra.peff.net>

Hi Peff,

Show 22 quoted lines

> Le 6 avr. 2020 à 16:19, Jeff King <peff@peff.net> a écrit :
> 
> One thought:
> 
>> diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt
>> index 7d3a60f5b93..95ea8499029 100644
>> --- a/Documentation/pull-fetch-param.txt
>> +++ b/Documentation/pull-fetch-param.txt
>> @@ -19,7 +19,8 @@ ifndef::git-pull[]
>> 	(see <<CRTB,CONFIGURED REMOTE-TRACKING BRANCHES>> below).
>> endif::git-pull[]
>> ifdef::git-pull[]
>> -	(see linkgit:git-fetch[1]).
>> +	(see the section "CONFIGURED REMOTE-TRACKING BRANCHES"
>> +	in linkgit:git-fetch[1]).
>> endif::git-pull[]
> 
> We can hyperlink directly to this section with the CRTB tag (as you can
> see in the context above). But I guess we don't have a portable macro to
> do so across different manpages. Assuming we'd need something like
> linkgit to accomplish, it's best not to hold up this change waiting for
> that.

I didn't know it was possible. I agree that cross-linking directly to a specific section would be great, especially if it would work for the manpages, the HTML documentation as well as the website!

Philippe.