Re: [PATCH 0/4] doc improvements for config includes

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, May 11, 2017 at 11:09 AM, Jeff King <peff@xxxxxxxx> wrote:
> On Thu, May 11, 2017 at 03:54:37AM -0400, Jeff King wrote:
>
>> On Thu, May 11, 2017 at 09:49:09AM +0200, Ævar Arnfjörð Bjarmason wrote:
>>
>> > > I don't like this because it copies the rules for _one_ property to the
>> > > conditional section. What happens when you're looking for some other
>> > > property of include.path?
>> >
>> > Yeah, as I said once I wrote it up I found it wasn't really any
>> > better, but just wanted to send an explanation for why I didn't find
>> > it while I remembered, as a sort of case study.
>> > [...]
>> > > I suspect that whole paragraph under Includes could be reworded to make
>> > > it clear that anything it is saying applies equally to include.$key and
>> > > includeIf.*.$key, and then that would future-proof us for other
>> > > modifications.
>>
>> What about this:
>
> I think this is the right path, but I actually ended up with an
> introductory paragraph about the two sections. I hope it makes the same
> point but is a bit less clunky.
>
> Here's a series that I think covers all the bits discussed here, and a
> few others.
>
>   [1/4]: docs/config: clarify include/includeIf relationship
>   [2/4]: docs/config: give a relative includeIf example
>   [3/4]: docs/config: avoid the term "expand" for includes
>   [4/4]: docs/config: consistify include.path examples

This whole thing looks great to me. Thanks!

Reviewed-by: Ævar Arnfjörð Bjarmason <avarab@xxxxxxxxx>

>  Documentation/config.txt | 31 +++++++++++++++++++++----------
>  1 file changed, 21 insertions(+), 10 deletions(-)
>
> -Peff




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]