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

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.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent a7ee04b3

Documentation/ABI/README

+9 −1
Original line number Diff line number Diff line
@@ -58,6 +58,14 @@ Users: All users of this interface who wish to be notified when 
		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:



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

CRA Git | Maintained and supported by SUSTech CRA and CCSE