linux-kernel - Re: [PATCH v6 10/21] tools/docs: sphinx-build-wrapper: add a wrapper for sphinx-build

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: <ed4eeee3-4e95-4bf4-b19f-cf7d38d8a1ea@gmail.com>
Date: Thu, 18 Sep 2025 08:43:19 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: Jonathan Corbet <corbet@....net>, mchehab+huawei@...nel.org
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 Jani Nikula <jani.nikula@...ux.intel.com>
Subject: Re: [PATCH v6 10/21] tools/docs: sphinx-build-wrapper: add a wrapper
 for sphinx-build

Hi Jon,

Jonathan Corbet wrote:
> Akira Yokosawa <akiyks@...il.com> writes:
> 
>> Wait!  In the cover-letter, you said:
>>
>>     It should be noticed that it is out of the scope of this series
>>     to change the implementation. Surely the process can be improved,
>>     but first let's consolidate and document everything on a single
>>     place.
>>
>> Removing current restriction on SPHINXDIRS does look inconsistent with
>> your own words to me.
>>
>> So, I guess I have to NAK 06/21 as well.
> 
> Is there an actual problem with this change that we need to know about?
> I am not quite understanding the objection here.

As Mauro has pointed out, and as I could not apply v6 series, I failed
to look at the whole patch.

My knee jerk reaction came from the fact that, for example,

    make SPHINXDIRS=translations/zh_CN pdfdocs

won't build.  This is because I didn't know such a sub-directory is
allowed (despite what "make dochelp" says) in SPHINXDIRS.

At the time I made "improvements in CJK font configs", I embedded
hacky ".. raw:: latex     \kerneldocCJKoff" and others in:

     Documentations/index.rst
                   /*/index.rst

, assuming all of those latex macros would appear in translations.tex
in the right order.

I admit it was not ideal, but I could not, and still can not, come up
with a more robust approach.

Hopefully, this explains enough for you.

Regards,
Akira