git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jeff King <peff@peff.net>
To: Philippe Blain via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Marc Branchaud <marcnarc@xiplink.com>,
	Clemens Buchacher <drizzd@gmx.net>,
	Philippe Blain <levraiphilippeblain@gmail.com>
Subject: Re: [PATCH 1/2] pull doc: refer to a specific section in 'fetch' doc
Date: Mon, 6 Apr 2020 16:19:45 -0400	[thread overview]
Message-ID: <20200406201945.GA1245278@coredump.intra.peff.net> (raw)
In-Reply-To: <9c94c2770f0eb1cbb9383cffde7c275d7d3f52c9.1586101819.git.gitgitgadget@gmail.com>

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

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

> 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

  reply	other threads:[~2020-04-06 20:19 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-05 15:50 [PATCH 0/2] git-pull.txt: correct outdated example + link to specific 'git fetch' section Philippe Blain via GitGitGadget
2020-04-05 15:50 ` [PATCH 1/2] pull doc: refer to a specific section in 'fetch' doc Philippe Blain via GitGitGadget
2020-04-06 20:19   ` Jeff King [this message]
2020-04-16 12:39     ` Philippe Blain
2020-04-05 15:50 ` [PATCH 2/2] pull doc: correct outdated description of an example Philippe Blain via GitGitGadget
2020-04-06 20:22   ` Jeff King

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200406201945.GA1245278@coredump.intra.peff.net \
    --to=peff@peff.net \
    --cc=drizzd@gmx.net \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=levraiphilippeblain@gmail.com \
    --cc=marcnarc@xiplink.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).