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

From: Jeff King <peff@peff.net>
Date: Apr 6, 2020, 20:19 UTC
Message-ID: <20200406201945.GA1245278@coredump.intra.peff.net>
In-Reply-To: <9c94c2770f0eb1cbb9383cffde7c275d7d3f52c9.1586101819.git.gitgitgadget@gmail.com>

On Sun, Apr 05, 2020 at 03:50:18PM +0000, Philippe Blain via GitGitGadget wrote:

Show 8 quoted lines

> From: Philippe Blain <levraiphilippeblain@gmail.com>
> 
> The documentation for the `<refspec>` parameter in the `git fetch`
> documentation refers to the section "CONFIGURED REMOTE-TRACKING
> BRANCHES" in this same documentation page.
> 
> In the `git pull` documentation, let's also refer specifically to this
> section instead of just linking to the `git fetch` documentation.

Makes sense. One thought:

Show 12 quoted lines

> 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.

-Peff