Re: [PATCH v2] docs: ABI: move README contents to the top
From: Jonathan Corbet
Date: Thu Feb 13 2025 - 11:52:33 EST
Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> 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@xxxxxxx>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> ---
> 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