linux-kernel - Re: [PATCH RFC 1/4] docs-rst: fix PDF build errors

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: <E833AA2A-7D81-4BCC-BB6F-1DA8B4AFCF7D@darmarit.de>
Date:   Wed, 2 Nov 2016 16:03:09 +0100
From:   Markus Heiser <markus.heiser@...marit.de>
To:     Mauro Carvalho Chehab <mchehab@....samsung.com>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        Jim Davis <jim.epost@...il.com>,
        Jonathan Corbet <corbet@....net>,
        linux-kernel <linux-kernel@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...nel.org>
Subject: Re: [PATCH RFC 1/4] docs-rst: fix PDF build errors


Am 01.11.2016 um 23:44 schrieb Mauro Carvalho Chehab <mchehab@....samsung.com>:

> PDF build on Kernel 4.9-rc? returns an error. This is
> because we're re-defining a command too late. Move
> such redefinition to LaTeX preamble.
> 
> Tested by building the documentation on interactive mode:
> 	make PDFLATEX=xelatex -C Documentation/output/./latex
> 
> Fixes: e61a39baf74d ("[media] index.rst: Fix LaTeX error in interactive mode on Sphinx 1.4.x")
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@....samsung.com>
> ---
> Documentation/conf.py         | 4 ++++
> Documentation/media/index.rst | 5 -----
> 2 files changed, 4 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index d9bad21dd427..814c336e5f5e 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -332,6 +332,10 @@ latex_elements = {
>      '''
> }
> 
> +# Fix reference escape troubles with Sphinx 1.4.x
> +if minor > 3:
> +    latex_elements['preamble']  += '\\renewcommand*{\\DUrole}[2]{ #2 }'

For Sphinx's version detection we should also include the
major version number e.g::

  if major == 1 and minor > 3:

BTW: can you also fix ...

 # The name of the math extension changed on Sphinx 1.4
-if minor > 3:
-    extensions.append("sphinx.ext.imgmath")
-else:
+if major == 1 and minor < 4:
     extensions.append("sphinx.ext.pngmath")
+else:
+    extensions.append("sphinx.ext.imgmath")
 
-- Markus --


> +
> # Grouping the document tree into LaTeX files. List of tuples
> # (source start file, target name, title,
> #  author, documentclass [howto, manual, or own class]).
> diff --git a/Documentation/media/index.rst b/Documentation/media/index.rst
> index e347a3e7bdef..7f8f0af620ce 100644
> --- a/Documentation/media/index.rst
> +++ b/Documentation/media/index.rst
> @@ -1,11 +1,6 @@
> Linux Media Subsystem Documentation
> ===================================
> 
> -.. Sphinx 1.4.x has a definition for DUrole that doesn't work on alltt blocks
> -.. raw:: latex
> -
> -	\renewcommand*{\DUrole}[2]{ #2 }
> -
> Contents:
> 
> .. toctree::
> -- 
> 2.7.4
> 
> 
> --
> To unsubscribe from this list: send the line "unsubscribe linux-doc" in
> the body of a message to majordomo@...r.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html