Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1452149 > unrolled thread

Makefile.sphinx:17: The 'sphinx-build' command was not found

Back to article view | Back to linux.kernel

Contents

  Makefile.sphinx:17: The 'sphinx-build' command was not found Christian Kujau <lists@nerdbynature.de> - 2016-07-29 00:20 +0200
    Re: Makefile.sphinx:17: The 'sphinx-build' command was not found Jonathan Corbet <corbet@lwn.net> - 2016-07-29 15:50 +0200
      Re: Makefile.sphinx:17: The 'sphinx-build' command was not found Jani Nikula <jani.nikula@intel.com> - 2016-08-01 11:40 +0200
        [PATCH] Documentation/sphinx: do not warn about missing tools in 'make help' Jani Nikula <jani.nikula@intel.com> - 2016-08-01 11:40 +0200
          Re: [PATCH] Documentation/sphinx: do not warn about missing tools  in 'make help' Jonathan Corbet <corbet@lwn.net> - 2016-08-04 00:10 +0200

#1452149 — Makefile.sphinx:17: The 'sphinx-build' command was not found

Hi,

since 22cba31bae ("Documentation/sphinx: add basic working Sphinx 
configuration and build") the following warning is emitted when running 
"make help":

$ make help > /dev/null 
Documentation/Makefile.sphinx:17: 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.

Indeed, I don't have "sphinx-build" installed (nor do I want to build 
documentation), running "make SPHINXBUILD=/bin/true help" makes the 
warning go away. Is there a way to omit the warning when 
running "make help"? E.g. by not including Documentation/Makefile.sphinx 
for that target?

Thanks,
Christian.
-- 
BOFH excuse #296:

The hardware bus needs a new token.

[toc] | [next] | [standalone]

#1452413

On Thu, 28 Jul 2016 15:05:07 -0700 (PDT)
Christian Kujau <lists@nerdbynature.de> wrote:

> Indeed, I don't have "sphinx-build" installed (nor do I want to build 
> documentation), running "make SPHINXBUILD=/bin/true help" makes the 
> warning go away. Is there a way to omit the warning when 
> running "make help"? E.g. by not including Documentation/Makefile.sphinx 
> for that target?

That seems like a reasonable request, we'll make it happen.

Thanks,

jon

[toc] | [prev] | [next] | [standalone]

#1453062

On Fri, 29 Jul 2016, Jonathan Corbet <corbet@lwn.net> wrote:
> On Thu, 28 Jul 2016 15:05:07 -0700 (PDT)
> Christian Kujau <lists@nerdbynature.de> wrote:
>
>> Indeed, I don't have "sphinx-build" installed (nor do I want to build 
>> documentation), running "make SPHINXBUILD=/bin/true help" makes the 
>> warning go away. Is there a way to omit the warning when 
>> running "make help"? E.g. by not including Documentation/Makefile.sphinx 
>> for that target?
>
> That seems like a reasonable request, we'll make it happen.

I think we should still display the help (without warnings!) even if the
tool is not available. Patch follows.

BR,
Jani.


-- 
Jani Nikula, Intel Open Source Technology Center

[toc] | [prev] | [next] | [standalone]

#1453071 — [PATCH] Documentation/sphinx: do not warn about missing tools in 'make help'

Simply move the dochelp rule outside of the HAVE_SPHINX check,
overriding the .DEFAULT rule for HAVE_SPHINX=0.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Christian Kujau <lists@nerdbynature.de>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---
 Documentation/Makefile.sphinx | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
index d8d13c92a178..bcb07f8dc664 100644
--- a/Documentation/Makefile.sphinx
+++ b/Documentation/Makefile.sphinx
@@ -67,6 +67,8 @@ cleanmediadocs:
 cleandocs:
 	$(Q)rm -rf $(BUILDDIR)
 
+endif # HAVE_SPHINX
+
 dochelp:
 	@echo  ' Linux kernel internal documentation in different formats (Sphinx):'
 	@echo  '  htmldocs        - HTML'
@@ -74,5 +76,3 @@ dochelp:
 	@echo  '  epubdocs        - EPUB'
 	@echo  '  xmldocs         - XML'
 	@echo  '  cleandocs       - clean all generated files'
-
-endif # HAVE_SPHINX
-- 
2.1.4

[toc] | [prev] | [next] | [standalone]

#1456038 — Re: [PATCH] Documentation/sphinx: do not warn about missing tools in 'make help'

On Mon,  1 Aug 2016 12:37:05 +0300
Jani Nikula <jani.nikula@intel.com> wrote:

> Simply move the dochelp rule outside of the HAVE_SPHINX check,
> overriding the .DEFAULT rule for HAVE_SPHINX=0.

I've applied this, will send it upward soonish.

Thanks,

jon

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web