All of lore.kernel.org
 help / color / mirror / Atom feed
* Extra messages from Makefile.sphinx
@ 2017-01-27 22:47 Jim Davis
  2017-01-30 16:58 ` [PATCH] Documentation/sphinx: make targets independent of Sphinx work for HAVE_SPHINX=0 Jani Nikula
  0 siblings, 1 reply; 4+ messages in thread
From: Jim Davis @ 2017-01-27 22:47 UTC (permalink / raw)
  To: linux-doc, linux-kernel

On a sphinx-free Ubuntu system with 4.10-rc5, make installmandocs
works just fine, but the garrulous Makefile.sphinx twice tells me I
don't have sphinx-build installed:

Documentation/Makefile.sphinx:22: The 'sphinx-build' 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 'sphinx-build'
executable.
  SKIP    Sphinx include/config/auto.conf target.
Documentation/Makefile.sphinx:22: The 'sphinx-build' 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 'sphinx-build'
executable.
  SKIP    Sphinx installmandocs target.

Would the 'SKIP ...' statements suffice?  It happens with make
cleandocs and make mandocs too.
-- 
Jim

^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH] Documentation/sphinx: make targets independent of Sphinx work for HAVE_SPHINX=0
  2017-01-27 22:47 Extra messages from Makefile.sphinx Jim Davis
@ 2017-01-30 16:58 ` Jani Nikula
  2017-01-30 17:12   ` Jani Nikula
  2017-02-01 20:13   ` Jonathan Corbet
  0 siblings, 2 replies; 4+ messages in thread
From: Jani Nikula @ 2017-01-30 16:58 UTC (permalink / raw)
  To: Jim Davis, linux-doc, linux-kernel; +Cc: jani.nikula

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@gmail.com>
Reference: http://lkml.kernel.org/r/CA+r1ZhjRVqkjPXGOGB_BOAX2Hkfb+qQCtTzFfBMFeH1Mfeej7w@mail.gmail.com
Signed-off-by: Jani Nikula <jani.nikula@intel.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'
-- 
2.1.4

^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH] Documentation/sphinx: make targets independent of Sphinx work for HAVE_SPHINX=0
  2017-01-30 16:58 ` [PATCH] Documentation/sphinx: make targets independent of Sphinx work for HAVE_SPHINX=0 Jani Nikula
@ 2017-01-30 17:12   ` Jani Nikula
  2017-02-01 20:13   ` Jonathan Corbet
  1 sibling, 0 replies; 4+ messages in thread
From: Jani Nikula @ 2017-01-30 17:12 UTC (permalink / raw)
  To: Jim Davis, linux-doc, linux-kernel

On Mon, 30 Jan 2017, Jani Nikula <jani.nikula@intel.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@gmail.com>
> Reference: http://lkml.kernel.org/r/CA+r1ZhjRVqkjPXGOGB_BOAX2Hkfb+qQCtTzFfBMFeH1Mfeej7w@mail.gmail.com

Cc: stable@vger.kernel.org

Might not be unreasonable.


> Signed-off-by: Jani Nikula <jani.nikula@intel.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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] Documentation/sphinx: make targets independent of Sphinx work for HAVE_SPHINX=0
  2017-01-30 16:58 ` [PATCH] Documentation/sphinx: make targets independent of Sphinx work for HAVE_SPHINX=0 Jani Nikula
  2017-01-30 17:12   ` Jani Nikula
@ 2017-02-01 20:13   ` Jonathan Corbet
  1 sibling, 0 replies; 4+ messages in thread
From: Jonathan Corbet @ 2017-02-01 20:13 UTC (permalink / raw)
  To: Jani Nikula; +Cc: Jim Davis, linux-doc, linux-kernel

On Mon, 30 Jan 2017 18:58:15 +0200
Jani Nikula <jani.nikula@intel.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.

Applied, thanks.

jon

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2017-02-01 20:13 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-01-27 22:47 Extra messages from Makefile.sphinx Jim Davis
2017-01-30 16:58 ` [PATCH] Documentation/sphinx: make targets independent of Sphinx work for HAVE_SPHINX=0 Jani Nikula
2017-01-30 17:12   ` Jani Nikula
2017-02-01 20:13   ` Jonathan Corbet

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.