Re: [PATCH] doc: substitute ETC_GIT(CONFIG|ATTRIBUTES) in generated docs

From: Todd Zullinger <tmz@pobox.com>
Date: Jun 27, 2018, 20:58 UTC
Message-ID: <20180627205843.GM20217@zaya.teonanacatl.net>
In-Reply-To: <xmqqlgb0goui.fsf@gitster-ct.c.googlers.com>

Junio C Hamano wrote:

Show 11 quoted lines

> Jeff King <peff@peff.net> writes:
> 
>> Specifically, I'm thinking of:
>>
>>   1. The pre-built documentation that Junio builds for
>>      quick-install-doc. This _could_ be customized during the "quick"
>>      step, but it's probably not worth the effort. However, we'd want
>>      some kind of generic fill-in then, and hopefully not
>>      "/home/jch/etc" or something.
> 
> That is very likely to happen, actually X-<.

Obviously, we don't want the end result to cause regressions in the common case or any burden on you. Would setting the ETC_GIT(CONFIG|ATTRIBUTES) variables in the dist-doc target alleviate that concern?

Alternately, we can make the default use generic paths and require some other knob to enable substituting the actual paths when building documentation.

I tend to think that the default should be to build documentation that is accurate for that build, but since it's something I'll set once for my package builds it's not a big deal either way to me.

-- 
Todd
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Einstein argued that there must be simplified explanations of nature,
because God is not capricious or arbitrary. No such faith comforts the
software engineer.
    -- Fred Brooks