linux-kernel - Re: [PATCH 1/3] docs: pdfdocs: Pull LaTeX preamble part out of conf.py

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]

Date:   Thu, 24 Feb 2022 12:33:25 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Akira Yokosawa <akiyks@...il.com>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH 1/3] docs: pdfdocs: Pull LaTeX preamble part out of conf.py

Akira Yokosawa <akiyks@...il.com> writes:

> Quote from Jon's remark [1]:
>
>     I do notice that Documentation/conf.py is getting large and
>     unapproachable.  At some future point, it might be nice to pull
>     all of the latex stuff out into a separate file where it won't
>     scare people who stumble into it by accident.
>
> Pull LaTeX preamble settings added since commit 3b4c963243b1 ("docs:
> conf.py: adjust the LaTeX document output") out into
> sphinx/kerneldoc-preamble.sty.
>
> It will be copied to the build directory by the added
> "latex_additional_files" setting in conf.py.
>
> As a bonus, LaTeX/TeX code can be maintained without escaping backslashes.

I've applied the set, thanks.  Still testing the pdfdocs build (and will
be for some time, naturally)

One little note, since you mentioned the need for backslash escapes:

> +# Load kerneldoc specific LaTeX settings
> +latex_elements['preamble'] += '''
> +        % Load kerneldoc specific LaTeX settings
> +	\\input{kerneldoc-preamble.sty}
> +'''

You can avoid that problem in Python code with the use of raw strings:

latex_elements['preamble'] += r'''
       % Load kerneldoc specific LaTeX settings
       \input{kerneldoc-preamble.sty}
'''

(note the "r" on the first line).  Something for future reference.

Thanks,

jon