linux-kernel - Re: [docs-next PATCH] Documentation/sphinx: skip build if user requested specific DOCBOOKS

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Fri, 01 Jul 2016 16:31:14 +0300
From:	Jani Nikula <jani.nikula@...el.com>
To:	Mauro Carvalho Chehab <mchehab@....samsung.com>
Cc:	Markus Heiser <markus.heiser@...marit.de>,
	Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
	linux-kernel@...r.kernel.org, hverkuil@...all.nl,
	daniel.vetter@...ll.ch, airlied@...il.com,
	grant.likely@...retlab.ca, rdunlap@...radead.org, keithp@...thp.com
Subject: Re: [docs-next PATCH] Documentation/sphinx: skip build if user requested specific DOCBOOKS

On Fri, 01 Jul 2016, Mauro Carvalho Chehab <mchehab@....samsung.com> wrote:
> Em Fri,  1 Jul 2016 15:24:44 +0300
> Jani Nikula <jani.nikula@...el.com> escreveu:
>
>> If the user requested specific DocBooks to be built using 'make
>> DOCBOOKS=foo.xml htmldocs', assume no Sphinx build is desired. This
>> check is transitional, and can be removed once we drop the DocBook
>> build.
>
> I guess this is actually a wrong assumption. I mean, it is valid to
> build multiple documents at the same time. Sometimes I do things
> like:
> 	make DOCBOOKS="media_api.xml device-drivers.xml" htmldocs
>
> When I want both docs to be compiled.
>
> What I would be expecting is that Sphinx would be looking into
> the DOCBOOKS targets and see if (some) of them belongs to it.
>
> Alternatively, we could add a separate makefile var for the
> Sphinx targets, but the logic would be more complex, as it
> should:

Please let's not conflate DOCBOOKS to mean something other than
DocBooks. I think it'll be easier that way.

So I guess we'll need a way to build just a subset of the Sphinx
documentation. I would like that to be a somewhat generic thing, not
requiring a separate conf file for each subset. Is the granularity of a
directory enough? I've been meaning to look into passing different
<sourcedir> and <filenames> to sphinx-build for this, but I don't have
the time now.

BR,
Jani.


-- 
Jani Nikula, Intel Open Source Technology Center