diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-09 15:25:05 +0200 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-09 16:07:10 +0200 |
commit | 96f69e0eef290dc617c04a31972fb0e82f588711 (patch) | |
tree | 8ffdcbd62275b6e6cc739602dd24f9048a7fd2dc /Documentation/media/uapi/cec/cec-header.rst | |
parent | Merge branch 'topic/cec' into topic/docs-next (diff) | |
download | linux-96f69e0eef290dc617c04a31972fb0e82f588711.tar.xz linux-96f69e0eef290dc617c04a31972fb0e82f588711.zip |
[media] doc-rst: add CEC header file to the documentation
Adding the header file is interesting for several reasons:
1) It makes MC documentation consistend with other parts;
2) The header file can be used as a quick index to all API
elements;
3) The cross-reference check helps to identify symbols that
aren't documented.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/cec/cec-header.rst')
-rw-r--r-- | Documentation/media/uapi/cec/cec-header.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/media/uapi/cec/cec-header.rst b/Documentation/media/uapi/cec/cec-header.rst new file mode 100644 index 000000000000..d5a9a2828274 --- /dev/null +++ b/Documentation/media/uapi/cec/cec-header.rst @@ -0,0 +1,10 @@ +.. -*- coding: utf-8; mode: rst -*- + +.. _cec_header: + +*************** +CEC Header File +*************** + +.. kernel-include:: $BUILDDIR/cec.h.rst + |