linux-kernel - Re: [PATCH v2] docs: ABI: move README contents to the top

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <87bjv56b8g.fsf@trenco.lwn.net>
Date: Thu, 13 Feb 2025 09:49:35 -0700
From: Jonathan Corbet <corbet@....net>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Linux Doc Mailing
 List <linux-doc@...r.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Mauro Carvalho Chehab
 <mchehab+huawei@...nel.org>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] docs: ABI: move README contents to the top

Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:

> The ABI documentation looks a little bit better if it starts
> with the contents of the README is placed at the beginning.
>
> Move it to the beginning of the ABI chapter. While here, improve
> the README text and change the title that will be shown at the
> html/pdf output to be coherent with both ABI file contents and
> with the generated documentation output.
>
> Suggested-by: Jonathan Corbet <corbet@....net>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
>  Documentation/ABI/README                      | 3 ++-
>  Documentation/admin-guide/abi-readme-file.rst | 6 ------
>  Documentation/admin-guide/abi.rst             | 3 ++-
>  scripts/lib/abi/abi_parser.py                 | 2 +-
>  4 files changed, 5 insertions(+), 9 deletions(-)
>  delete mode 100644 Documentation/admin-guide/abi-readme-file.rst

Applied, thanks.

jon