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 for Android: free password hash cracker in your pocket

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

Date:	Fri, 1 Jul 2016 10:15:55 -0300
From:	Mauro Carvalho Chehab <mchehab@....samsung.com>
To:	Jani Nikula <jani.nikula@...el.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

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:

not ignore:
	make htmldocs

ignore:
	make DOCBOOKS="device-drivers.xml" htmldocs

not ignore:
	make SPHINXDOCS="linux_tv" DOCBOOKS="device-drivers.xml" htmldocs

not ignore:
	make SPHINXDOCS="linux_tv" htmldocs

Regards,
Mauro

> 
> Cc: Markus Heiser <markus.heiser@...marit.de>
> Cc: Mauro Carvalho Chehab <mchehab@....samsung.com>
> Fixes: 22cba31bae9d ("Documentation/sphinx: add basic working Sphinx configuration and build")
> Signed-off-by: Jani Nikula <jani.nikula@...el.com>
> ---
>  Documentation/Makefile.sphinx | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
> index 6c203745b6c6..d8d13c92a178 100644
> --- a/Documentation/Makefile.sphinx
> +++ b/Documentation/Makefile.sphinx
> @@ -17,6 +17,12 @@ ifeq ($(HAVE_SPHINX),0)
>  	$(warning The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed and in PATH, or set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable.)
>  	@echo "  SKIP    Sphinx $@ target."
>  
> +else ifneq ($(DOCBOOKS),)
> +
> +# Skip Sphinx build if the user explicitly requested DOCBOOKS.
> +.DEFAULT:
> +	@echo "  SKIP    Sphinx $@ target (DOCBOOKS specified)."
> +
>  else # HAVE_SPHINX
>  
>  # User-friendly check for rst2pdf


-- 
Thanks,
Mauro