Commit c7e45ea4 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman

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: default avatarJonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/178a997070debd1953ba7d302c375948501d6193.1604042072.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent a7ee04b3
...@@ -32,7 +32,7 @@ The different levels of stability are: ...@@ -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 ...@@ -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
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment