Re: [PATCH v4 1/2] Documentation: fix linkgit references
- From
Jeff King <peff@peff.net>
- Date
- May 4, 2016, 08:57 UTC
- Message-ID
- <20160504085708.GA17920@sigill.intra.peff.net>
- In-Reply-To
- <F6210682-2FCA-423D-B6D3-06938C95D497@gmail.com>
On Wed, May 04, 2016 at 10:43:04AM +0200, Lars Schneider wrote:
Show 20 quoted lines
> > diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt > > index 73fd9e8..6538cb1 100644 > > --- a/Documentation/git-filter-branch.txt > > +++ b/Documentation/git-filter-branch.txt > > @@ -205,8 +205,8 @@ to other tags will be rewritten to point to the underlying commit. > > Remap to ancestor > > ~~~~~~~~~~~~~~~~~ > > > > -By using linkgit:rev-list[1] arguments, e.g., path limiters, you can limit the > > -set of revisions which get rewritten. However, positive refs on the command > > +By using linkgit:git-rev-list[1] arguments, e.g., path limiters, you can limit > > +the set of revisions which get rewritten. However, positive refs on the command > > All other linkgit fixes seem legimiate to me although I am not sure of this case > > -linkgit:rev-list[1] > +linkgit:git-rev-list[1] > > "rev-list" works but I think "git-rev-list" would be the canonical form? > See: https://git-scm.com/docs/git-filter-branch
It should definitely be "git-rev-list". The "linkgit" macro will format whatever text you feed it. For the manpages, that doesn't matter, because they don't actually hyperlink. But for other formats (like HTML), using just "rev-list" will generate a broken link.
-Peff