linux-kernel - Re: [PATCH] Documentation/sphinx: make targets independent of Sphinx work for HAVE

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]

Message-ID: <874m0giia9.fsf@intel.com>
Date:   Mon, 30 Jan 2017 19:12:14 +0200
From:   Jani Nikula <jani.nikula@...el.com>
To:     Jim Davis <jim.epost@...il.com>,
        linux-doc <linux-doc@...r.kernel.org>,
        linux-kernel <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] Documentation/sphinx: make targets independent of Sphinx work for HAVE_SPHINX=0

On Mon, 30 Jan 2017, Jani Nikula <jani.nikula@...el.com> wrote:
> Make targets that don't depend on Sphinx work without warnings about
> missing Sphinx. 'make cleandocs' will work without Sphinx just fine, and
> the targets that are no-ops for Sphinx should just be skipped. Move them
> outside of the HAVE_SPHINX checks to take precedence over the .DEFAULT
> target for HAVE_SPHINX=0.
>
> Reported-by: Jim Davis <jim.epost@...il.com>
> Reference: http://lkml.kernel.org/r/CA+r1ZhjRVqkjPXGOGB_BOAX2Hkfb+qQCtTzFfBMFeH1Mfeej7w@mail.gmail.com

Cc: stable@...r.kernel.org

Might not be unreasonable.


> Signed-off-by: Jani Nikula <jani.nikula@...el.com>
> ---
>  Documentation/Makefile.sphinx | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
> index 707c65337ebf..d1aa7ffdea64 100644
> --- a/Documentation/Makefile.sphinx
> +++ b/Documentation/Makefile.sphinx
> @@ -90,6 +90,11 @@ epubdocs:
>  xmldocs:
>  	@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,xml,$(var),xml,$(var)))
>  
> +endif # HAVE_SPHINX
> +
> +# The following targets are independent of HAVE_SPHINX, and the rules should
> +# work or silently pass without Sphinx.
> +
>  # no-ops for the Sphinx toolchain
>  sgmldocs:
>  psdocs:
> @@ -100,8 +105,6 @@ cleandocs:
>  	$(Q)rm -rf $(BUILDDIR)
>  	$(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) -C Documentation/media clean
>  
> -endif # HAVE_SPHINX
> -
>  dochelp:
>  	@echo  ' Linux kernel internal documentation in different formats (Sphinx):'
>  	@echo  '  htmldocs        - HTML'

-- 
Jani Nikula, Intel Open Source Technology Center