summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/rc/lirc-read.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-08-19 21:59:31 +0200
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-08-23 02:23:46 +0200
commit15c190146c5d1843d2eda0aac8be21d22c3ac431 (patch)
tree8b8e55e3e53cb2b7b4fb1d555ca906a3adfa3c7a /Documentation/media/uapi/rc/lirc-read.rst
parent[media] docs-rst: Convert CEC uAPI to use C function references (diff)
downloadlinux-15c190146c5d1843d2eda0aac8be21d22c3ac431.tar.xz
linux-15c190146c5d1843d2eda0aac8be21d22c3ac431.zip
[media] docs-rst: Convert LIRC uAPI to use C function references
Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation to make them to look more like the rest of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/rc/lirc-read.rst')
-rw-r--r--Documentation/media/uapi/rc/lirc-read.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/media/uapi/rc/lirc-read.rst b/Documentation/media/uapi/rc/lirc-read.rst
index c5b5e1db7cad..62bd3d8c9c67 100644
--- a/Documentation/media/uapi/rc/lirc-read.rst
+++ b/Documentation/media/uapi/rc/lirc-read.rst
@@ -21,6 +21,7 @@ Synopsis
.. c:function:: ssize_t read( int fd, void *buf, size_t count )
+ :name lirc-read
Arguments
@@ -30,8 +31,10 @@ Arguments
File descriptor returned by ``open()``.
``buf``
-``count``
+ Buffer to be filled
+``count``
+ Max number of bytes to read
Description
===========