Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Mauro Carvalho Chehab and committed by
Greg Kroah-Hartman
c7e45ea4 a7ee04b3

+9 -1
+9 -1
Documentation/ABI/README
··· 32 32 layout of the files below for details on how to do this.) 33 33 34 34 obsolete/ 35 - This directory documents interfaces that are still remaining in 35 + This directory documents interfaces that are still remaining in 36 36 the kernel, but are marked to be removed at some later point in 37 37 time. The description of the interface will document the reason 38 38 why it is obsolete and when it can be expected to be removed. ··· 57 57 sure they are working in a proper way and do not need to 58 58 be changed further. 59 59 60 + 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 + === 60 68 61 69 How things move between levels: 62 70