diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-11-30 08:00:45 -0500 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-12-14 10:35:30 -0500 |
| commit | c6b73bfcead9500e6b841cadb44f38324202ef77 (patch) | |
| tree | 0d26109ab05ae7eb5553203a53b28a36501faf49 /Documentation/media/uapi/rc/lirc-write.rst | |
| parent | 57c642cb45d6f7d0d950c3bc67439989062ac743 (diff) | |
media: RC docs: add enum rc_proto description at the docs
This is part of the uAPI. Add it to the documentation again,
and fix cross-references.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Acked-by: Sean Young <sean@mess.org>
Diffstat (limited to 'Documentation/media/uapi/rc/lirc-write.rst')
| -rw-r--r-- | Documentation/media/uapi/rc/lirc-write.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/media/uapi/rc/lirc-write.rst b/Documentation/media/uapi/rc/lirc-write.rst index 3d7541bad8b9..dd3d1fe807a6 100644 --- a/Documentation/media/uapi/rc/lirc-write.rst +++ b/Documentation/media/uapi/rc/lirc-write.rst @@ -57,8 +57,8 @@ driver returns ``EINVAL``. When in :ref:`LIRC_MODE_SCANCODE <lirc-mode-scancode>` mode, one ``struct lirc_scancode`` must be written to the chardev at a time, else ``EINVAL`` is returned. Set the desired scancode in the ``scancode`` member, -and the protocol in the ``rc_proto`` member. All other members must be set -to 0, else ``EINVAL`` is returned. If there is no protocol encoder +and the protocol in the :c:type:`rc_proto`: member. All other members must be +set to 0, else ``EINVAL`` is returned. If there is no protocol encoder for the protocol or the scancode is not valid for the specified protocol, ``EINVAL`` is returned. The write function may not wait until the scancode is transmitted. |