[1/3] doc-rst: generic way to build PDF of sub-folders

Message ID 605152A9-0EC8-40DD-8671-437D6369CA94@darmarit.de (mailing list archive)
State RFC, archived
Headers

Commit Message

Markus Heiser Nov. 2, 2016, 2:07 p.m. UTC
  Am 02.11.2016 um 12:43 schrieb Jani Nikula <jani.nikula@intel.com>:

> On Wed, 24 Aug 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
>> From: Markus Heiser <markus.heiser@darmarIT.de>
>> 
>> This extends the method to build only sub-folders to the targets
>> "latexdocs" and "pdfdocs". To do so, a conf.py in the sub-folder is
>> required, where the latex_documents of the sub-folder are
>> defined. E.g. to build only gpu's PDF add the following to the
>> Documentation/gpu/conf.py::
>> 
>>  +latex_documents = [
>>  +    ("index", "gpu.tex", "Linux GPU Driver Developer's Guide",
>>  +     "The kernel development community", "manual"),
>>  +]
>> 
>> and run:
>> 
>>  make SPHINXDIRS=gpu pdfdocs
> 
> Did you ever try this with more than one subfolder?

Seems not, there is a ";" missed in the 'foreach' loop, see patch
below.

To avoid conflicts, can you apply the ";" on your 
"Makefile.sphinx improvements" series? / Thanks



--Markus --

--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
  

Comments

Jani Nikula Nov. 2, 2016, 2:48 p.m. UTC | #1
On Wed, 02 Nov 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
> Am 02.11.2016 um 12:43 schrieb Jani Nikula <jani.nikula@intel.com>:
>
>> On Wed, 24 Aug 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
>>> From: Markus Heiser <markus.heiser@darmarIT.de>
>>> 
>>> This extends the method to build only sub-folders to the targets
>>> "latexdocs" and "pdfdocs". To do so, a conf.py in the sub-folder is
>>> required, where the latex_documents of the sub-folder are
>>> defined. E.g. to build only gpu's PDF add the following to the
>>> Documentation/gpu/conf.py::
>>> 
>>>  +latex_documents = [
>>>  +    ("index", "gpu.tex", "Linux GPU Driver Developer's Guide",
>>>  +     "The kernel development community", "manual"),
>>>  +]
>>> 
>>> and run:
>>> 
>>>  make SPHINXDIRS=gpu pdfdocs
>> 
>> Did you ever try this with more than one subfolder?
>
> Seems not, there is a ";" missed in the 'foreach' loop, see patch
> below.
>
> To avoid conflicts, can you apply the ";" on your 
> "Makefile.sphinx improvements" series? / Thanks

Thanks, done.

http://lkml.kernel.org/r/1478097913-12561-1-git-send-email-jani.nikula@intel.com

>
> diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
> index 92deea3..b7fbd12 100644
> --- a/Documentation/Makefile.sphinx
> +++ b/Documentation/Makefile.sphinx
> @@ -76,7 +76,7 @@ endif # HAVE_PDFLATEX
>  
>  pdfdocs: latexdocs
>  ifneq ($(HAVE_PDFLATEX),0)
> -       $(foreach var,$(SPHINXDIRS), $(MAKE) PDFLATEX=xelatex LATEXOPTS="-interaction=nonstopmode" -C $(BUILDDIR)/$(var)/latex)
> +       $(foreach var,$(SPHINXDIRS), $(MAKE) PDFLATEX=xelatex LATEXOPTS="-interaction=nonstopmode" -C $(BUILDDIR)/$(var)/latex;)
>  endif # HAVE_PDFLATEX
>  
>  epubdocs:
>
>
> --Markus --
>
  

Patch

diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
index 92deea3..b7fbd12 100644
--- a/Documentation/Makefile.sphinx
+++ b/Documentation/Makefile.sphinx
@@ -76,7 +76,7 @@  endif # HAVE_PDFLATEX
 
 pdfdocs: latexdocs
 ifneq ($(HAVE_PDFLATEX),0)
-       $(foreach var,$(SPHINXDIRS), $(MAKE) PDFLATEX=xelatex LATEXOPTS="-interaction=nonstopmode" -C $(BUILDDIR)/$(var)/latex)
+       $(foreach var,$(SPHINXDIRS), $(MAKE) PDFLATEX=xelatex LATEXOPTS="-interaction=nonstopmode" -C $(BUILDDIR)/$(var)/latex;)
 endif # HAVE_PDFLATEX
 
 epubdocs: