Re: [PATCH v3 16/24] config: create core.multiPackIndex setting

From: SZEDER Gábor <szeder.dev@gmail.com>
Date: Jul 12, 2018, 13:31 UTC
Message-ID: <CAM0VKjkuC5Qc6HtQZP4dpHE4CcCvNkg1D8_AFw7+PQDU6bU5Wg@mail.gmail.com>
In-Reply-To: <dd2f774d-a217-0273-efbe-d133ae23c5bc@gmail.com>

On Thu, Jul 12, 2018 at 3:01 PM Derrick Stolee <stolee@gmail.com> wrote:

Show 25 quoted lines

>
> On 7/11/2018 5:48 AM, SZEDER Gábor wrote:
> >> diff --git a/Documentation/config.txt b/Documentation/config.txt
> >> index ab641bf5a9..ab895ebb32 100644
> >> --- a/Documentation/config.txt
> >> +++ b/Documentation/config.txt
> >> @@ -908,6 +908,10 @@ core.commitGraph::
> >>      Enable git commit graph feature. Allows reading from the
> >>      commit-graph file.
> >>
> >> +core.multiPackIndex::
> >> +    Use the multi-pack-index file to track multiple packfiles using a
> >> +    single index. See linkgit:technical/multi-pack-index[1].
> > The 'linkgit' macro should be used to create links to other man pages,
> > but 'technical/multi-pack-index' is not a man page and this causes
> > 'make check-docs' to complain:
> >
> >        LINT lint-docs
> >    ./config.txt:929: nongit link: technical/multi-pack-index[1]
> >    Makefile:456: recipe for target 'lint-docs' failed
> >    make[1]: *** [lint-docs] Error 1
> >
> Thanks for this point. It seems to work using
> "link:technical/multi-pack-index[1]", which is what I'll use in the next
> version.

It doesn't work, it merely works around the build failure.

The generated man page looks like this:

  core.multiPackIndex
      Use the multi-pack-index file to track multiple packfiles using a
      single index. See 1[1].

And the resulting html page looks similar:

  core.multiPackIndex

      Use the multi-pack-index file to track multiple packfiles using a
      single index. See 1.

where that "1" is a link pointing to the non-existing URL file:///home/me/src/git/Documentation/technical/multi-pack-index