Re: [PATCH v2 2/2] doc: specify an 'html' build sub-directory for the htmldocs target

[Maxim Cournoyer <maxim.cournoyer@gmail.com>]

Hi Jonathan,

Jonathan Corbet <corbet@lwn.net> writes:

> Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:
>
>> Having the generated HTML documentation under its own output
>> sub-directory makes it easier to install, since it's clean from
>> .doctrees or other output formats.
>>
>> Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
>> ---
>>  Documentation/Makefile | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/Makefile b/Documentation/Makefile
>> index bb73dcb5ed05..bd8dac560633 100644
>> --- a/Documentation/Makefile
>> +++ b/Documentation/Makefile
>> @@ -93,7 +93,7 @@ quiet_cmd_sphinx = SPHINX  $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
>>  
>>  htmldocs:
>>  	@$(srctree)/scripts/sphinx-pre-install --version-check
>> -	@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
>> +	@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),html,$(var)))
>
> I think I'm going to hold off on this one.  As I said before, it would
> have made sense to do things this way when we made the transition.  At
> this point, though, I think the potential for trouble outweighs the
> benefits that would come from moving things around in this way.

OK.  The potential for troubles would lie with the scripts to deploy the
doc to the web site, I'd guess?  If that's the place we'd expect
problems, I'm happy to be pointed to it and can try adjusting the
scripts for the change.

Otherwise, I can keep applying this small patch locally to my build, as
it makes it much easier to cleanly install both the HTML and info target
outputs when packaging the kernel and its documentation.

-- 
Thanks,
Maxim