Skip to content

Commit c7e45ea

Browse files
mchehabgregkh
authored andcommitted
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>
1 parent a7ee04b commit c7e45ea

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

Documentation/ABI/README

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The different levels of stability are:
3232
layout of the files below for details on how to do this.)
3333

3434
obsolete/
35-
This directory documents interfaces that are still remaining in
35+
This directory documents interfaces that are still remaining in
3636
the kernel, but are marked to be removed at some later point in
3737
time. The description of the interface will document the reason
3838
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
5858
be changed further.
5959

6060

61+
Note:
62+
The fields should be use a simple notation, compatible with ReST markup.
63+
Also, the file **should not** have a top-level index, like::
64+
65+
===
66+
foo
67+
===
68+
6169
How things move between levels:
6270

6371
Interfaces in stable may move to obsolete, as long as the proper

0 commit comments

Comments
 (0)