linux-kernel - Re: [PATCH v2 00/53] Get rid of Docbook

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: <20170714225213.0a6dba4f@vento.lan>
Date:   Fri, 14 Jul 2017 22:52:13 -0300
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Jim Davis <jim.epost@...il.com>
Cc:     Markus Heiser <markus.heiser@...marit.de>,
        Jani Nikula <jani.nikula@...el.com>,
        Jonathan Corbet <corbet@....net>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        "linux-kernel@...r.kernel.org org List" 
        <linux-kernel@...r.kernel.org>,
        David Woodhouse <dwmw2@...radead.org>,
        Brian Norris <computersforpeace@...il.com>,
        Boris Brezillon <boris.brezillon@...e-electrons.com>,
        Marek Vasut <marek.vasut@...il.com>,
        Richard Weinberger <richard@....at>,
        Cyrille Pitchen <cyrille.pitchen@...el.com>,
        linux-mtd@...ts.infradead.org
Subject: Re: [PATCH v2 00/53] Get rid of Docbook

Em Fri, 14 Jul 2017 16:15:23 -0700
Jim Davis <jim.epost@...il.com> escreveu:

> On Thu, Jul 6, 2017 at 1:54 AM, Markus Heiser <markus.heiser@...marit.de> wrote:
> 
> >  52b3f23 Docs: clean up some DocBook loose ends  
> 
> Speaking of minor loose ends,
> 
> make SPHINXDIRS=userspace-api pdfdocs
> 
> works -- though now that it's all sphinx, wouldn't just DIRS be better? -- and

Hmm... I don't like the idea of just DIRS, as there are other paths
used on Makefile (INSTALL_PATH, INSTALL_MOD_PATH, INSTALL_HDR_PATH).

> 
> make DOCBOOKS=userspace-api pdfdocs
> 
> still works too.  But that generates all of the pdf files, and not
> just the userspace-api.pdf. 

It will just ignore it. The same happens if you do:
	make FOO=bar htmldocs

Yet, it could make sense to either warn or make it equivalent to
SPHINXDIRS at the Documentation/Makefile.

> And running now-dead targets like "make
> ps" or "make sgmldocs" or "make mandocs" just returns with no output.

Yeah. We need to get rid of those targets from Documentation/Makefile:

	sgmldocs:
	psdocs:
	mandocs:
	installmandocs:

I guess the enclosed patch should do the trick.

Thanks,
Mauro

-

docs: Makefile: remove no-ops targets

After removal of DocBook, those targets are bogus.

Reported-by: Jim Davis <jim.epost@...il.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@...pensource.com>

diff --git a/Documentation/Makefile b/Documentation/Makefile
index a42320385df3..d75c00e3aadb 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -95,16 +95,6 @@ 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:
-	@:
-mandocs:
-	@:
-installmandocs:
-	@:
-
 cleandocs:
 	$(Q)rm -rf $(BUILDDIR)
 	$(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media clean
diff --git a/Documentation/translations/zh_CN/HOWTO b/Documentation/translations/zh_CN/HOWTO
index 11be075ba5fa..5f6d09edc9ac 100644
--- a/Documentation/translations/zh_CN/HOWTO
+++ b/Documentation/translations/zh_CN/HOWTO
@@ -149,9 +149,7 @@ Linux内核代码中包含有大量的文档。这些文档对于学习如何与
 核源码的主目录中使用以下不同命令将会分别生成PDF、Postscript、HTML和手册
 页等不同格式的文档：
     make pdfdocs
-    make psdocs
     make htmldocs
-    make mandocs
 
 
 如何成为内核开发者
diff --git a/Makefile b/Makefile
index 547947ff87de..5db9c669e541 100644
--- a/Makefile
+++ b/Makefile
@@ -1459,7 +1459,7 @@ $(help-board-dirs): help-%:
 
 # Documentation targets
 # ---------------------------------------------------------------------------
-DOC_TARGETS := xmldocs sgmldocs psdocs latexdocs pdfdocs htmldocs mandocs installmandocs epubdocs cleandocs linkcheckdocs
+DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs linkcheckdocs
 PHONY += $(DOC_TARGETS)
 $(DOC_TARGETS): scripts_basic FORCE
 	$(Q)$(MAKE) $(build)=Documentation $@