linux-kernel - Re: [PATCH v3 6/9] docs: pdfdocs: One-half spacing for CJK translations

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, 12 Aug 2021 08:42:48 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Akira Yokosawa <akiyks@...il.com>,
        Mauro Carvalho Chehab <mchehab@...nel.org>
Cc:     "Wu X.C." <bobwxc@...il.cn>, SeongJae Park <sj38.park@...il.com>,
        Hu Haowen <src.res@...il.cn>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH v3 6/9] docs: pdfdocs: One-half spacing for CJK
 translations

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

> On Mon, 2 Aug 2021 18:56:16 +0900, Akira Yokosawa wrote:
>> CJK documents are much easier to read with a wider baseline stretch.
>> Applying the onehalfspacing option of "setspace" package looks
>> reasonable.
>> 
>> Note: \usepackage{setspace} needs to be before that of hyperref in the
>> preamble.  The 'extrapackages' key (available since Sphinx 2.3) is for
>> this purpose.
>
> Sphinx versions < 2.3 ignore 'extrapackages' and generate LaTeX
> sources without setspace package.
> Obviously, building such LaTeX sources will end up in the error of:
>
>     ! Undefined control sequence.
>     \kerneldocCJKoff ...exeCJKinactive \singlespacing
>
> Current requirement to build pdfdocs is Sphinx 2.4.4, but LaTeX
> sources generated by 1.7.9 can at least be built prior to this change.
>
> Jon, Mauro, do you think this is a regression?

Having the build just fail that way isn't really a good thing...it would
be far better to do the baseline tweaking only with versions of sphinx
that support it or, failing that, to at least refuse to build with a
suitably informative message.

Thanks,

jon