linux-kernel - Re: [PATCH 00/11] docs: remove submitting-drivers.rst

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: <87sfn44wk4.fsf@meer.lwn.net>
Date:   Wed, 13 Jul 2022 13:55:23 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Lukas Bulwahn <lukas.bulwahn@...il.com>,
        Federico Vaga <federico.vaga@...a.pv.it>,
        Alex Shi <alexs@...nel.org>,
        Yanteng Si <siyanteng@...ngson.cn>,
        Hu Haowen <src.res@...il.cn>, linux-doc@...r.kernel.org,
        linux-doc-tw-discuss@...ts.sourceforge.net
Cc:     Jean Delvare <jdelvare@...e.com>,
        Guenter Roeck <linux@...ck-us.net>,
        linux-hwmon@...r.kernel.org, kernel-janitors@...r.kernel.org,
        linux-kernel@...r.kernel.org,
        Lukas Bulwahn <lukas.bulwahn@...il.com>
Subject: Re: [PATCH 00/11] docs: remove submitting-drivers.rst

Lukas Bulwahn <lukas.bulwahn@...il.com> writes:

> Dear Jonathan, dear Federico, dear Alex, dear Yanteng, dear Hu,
>
> Here is an attempt to delete submitting-drivers with some improvements
> and clean-up in other documentation places to convince ourselves that
> nothing valuable is lost when deleting this checklist.

So my purpose today was to go ahead and apply these patches, but ...

> Patch 1, 2 and 3 is just basic clean-up before adding a new reference (see
> Patch 4). Patch 4 adds the one reference from submitting-drivers, not
> already mentioned elsewhere in the repository. Patch 5 updates a confusing
> statement in devices.rst from earlier .txt/.tex distinction times to the
> new state now with Sphinx & .rst.
>
> Patch 6 finally deletes the outdated document, with a cross-check what is
> covered elsewhere and few open questions (see below).
>
> Patch 7 and 8 have been reworked with the native-speaking doc maintainers;
> they cause no new warnings and are ready to pick,
>
> Patch 9 to 11 are weak attempts to adjust the translation, but they need
> to be taken further by others due to my lack of knowledge on the other
> languages.  They would currently also cause new warnings in the doc-build
> right now. They should not be picked if there is no one to continue
> to adjust the text and fix the warnings on broken references.
>
> I hope that patches 1 to 8 can be picked into doc-next, and then we see
> how to fix up the translations as well.

...even if I do that I get warnings:

  Documentation/translations/zh_CN/process/howto.rst:98: WARNING:
  undefined label: submittingdrivers (if the link has no caption the
  label must precede a section header)

it's actually better if I apply the full series, but there's still a few
of them.  I *really* don't want to add more warnings to the docs build,
so I've backed off for now.

Alex, can you fix the remaining references in zh_CN?

For zh_TW I'm wondering ... that is increasingly looking like an
unmaintained drive-by submission.  I suppose we can just brute-force
remove the references, but I once again find myself wondering about the
value of this translation.  Is there anybody out there who cares about
it who could fix this up properly?

Thanks,

jon