hollalinux
/
linux-sg2042
mirror of https://github.com/sophgo/linux-riscv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: ABI: README: specify that files should be ReST compatible 

As we plan to remove the escaping code from the scripts/get_abi.pl,
specify at the ABI README file that the content of the file should
be ReST compatible.

Acked-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/178a997070debd1953ba7d302c375948501d6193.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Mauro Carvalho Chehab 2020-10-30 08:40:37 +01:00 committed by Greg Kroah-Hartman
parent a7ee04b3ef
commit c7e45ea429
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/ABI/README
View File

@ -32,7 +32,7 @@ The different levels of stability are:
layout of the files below for details on how to do this.) layout of the files below for details on how to do this.)
obsolete/ obsolete/
This directory documents interfaces that are still remaining in This directory documents interfaces that are still remaining in
the kernel, but are marked to be removed at some later point in the kernel, but are marked to be removed at some later point in
time. The description of the interface will document the reason time. The description of the interface will document the reason
why it is obsolete and when it can be expected to be removed. why it is obsolete and when it can be expected to be removed.
@ -58,6 +58,14 @@ Users: All users of this interface who wish to be notified when
be changed further. be changed further.
Note:
The fields should be use a simple notation, compatible with ReST markup.
Also, the file **should not** have a top-level index, like::
===
foo
===
How things move between levels: How things move between levels:
Interfaces in stable may move to obsolete, as long as the proper Interfaces in stable may move to obsolete, as long as the proper