From: Derrick Stolee <stolee@gmail.com>
Date: Thu, 12 Jul 2018 15:40:33 GMT
Subject: Re: [PATCH v3 16/24] config: create core.multiPackIndex setting
Message-ID: <540316c3-b74e-f187-797a-2b2d0b14c025@gmail.com>
In-Reply-To: <CAM0VKjkuC5Qc6HtQZP4dpHE4CcCvNkg1D8_AFw7+PQDU6bU5Wg@mail.gmail.com>

On 7/12/2018 9:31 AM, SZEDER Gábor wrote:
> On Thu, Jul 12, 2018 at 3:01 PM Derrick Stolee <stolee@gmail.com> wrote:
>> 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

Right. Sorry. I also see that I use the correct kind of links in 
Documentation/git-multi-pack-index.txt (see below) so I will use it 
here, too.

SEE ALSO
--------
See link:technical/multi-pack-index.html[The Multi-Pack-Index Design
Document] and link:technical/pack-format.html[The Multi-Pack-Index
Format] for more information on the multi-pack-index feature.

Thanks,

-Stolee