Improve LIRC documentation
Subsystems (2)
cover Improve LIRC documentation
Hi Sean,
Those two patches improve LIRC uAPI docs by adding the structs documented at lirc.h to the output of Documentation/output/userspace-api/media/rc/lirc-dev-intro.html
Please review.
Mauro Carvalho Chehab (2):
media: docs: uAPI: rc: dual-license the docs with GPL v2
media: rc: improve LIRC documentation
Documentation/userspace-api/media/rc/keytable.c.rst | 2 +- .../userspace-api/media/rc/lirc-dev-intro.rst | 13 ++++++++++--- Documentation/userspace-api/media/rc/lirc-dev.rst | 2 +- Documentation/userspace-api/media/rc/lirc-func.rst | 2 +- .../userspace-api/media/rc/lirc-get-features.rst | 2 +- .../userspace-api/media/rc/lirc-get-rec-mode.rst | 2 +- .../media/rc/lirc-get-rec-resolution.rst | 2 +- .../userspace-api/media/rc/lirc-get-send-mode.rst | 2 +- .../userspace-api/media/rc/lirc-get-timeout.rst | 2 +- .../userspace-api/media/rc/lirc-header.rst | 2 +- Documentation/userspace-api/media/rc/lirc-read.rst | 2 +- .../media/rc/lirc-set-measure-carrier-mode.rst | 2 +- .../media/rc/lirc-set-rec-carrier-range.rst | 2 +- .../userspace-api/media/rc/lirc-set-rec-carrier.rst | 2 +- .../media/rc/lirc-set-rec-timeout-reports.rst | 2 +- .../userspace-api/media/rc/lirc-set-rec-timeout.rst | 2 +- .../media/rc/lirc-set-send-carrier.rst | 2 +- .../media/rc/lirc-set-send-duty-cycle.rst | 2 +- .../media/rc/lirc-set-transmitter-mask.rst | 2 +- .../media/rc/lirc-set-wideband-receiver.rst | 2 +- Documentation/userspace-api/media/rc/lirc-write.rst | 2 +- Documentation/userspace-api/media/rc/rc-intro.rst | 2 +- Documentation/userspace-api/media/rc/rc-protos.rst | 2 +- .../userspace-api/media/rc/rc-sysfs-nodes.rst | 2 +- .../userspace-api/media/rc/rc-table-change.rst | 2 +- Documentation/userspace-api/media/rc/rc-tables.rst | 2 +- .../userspace-api/media/rc/remote_controllers.rst | 2 +- include/uapi/linux/lirc.h | 2 +- 28 files changed, 37 insertions(+), 30 deletions(-)
Signature · 1 line
2.28.0
PATCH 1/2 media: docs: uAPI: rc: dual-license the docs with GPL v2
Make the license for those documents also compatible with GPLv2.
--- Documentation/userspace-api/media/rc/keytable.c.rst | 2 +- Documentation/userspace-api/media/rc/lirc-dev-intro.rst | 2 +- Documentation/userspace-api/media/rc/lirc-dev.rst | 2 +- Documentation/userspace-api/media/rc/lirc-func.rst | 2 +- Documentation/userspace-api/media/rc/lirc-get-features.rst | 2 +- Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst | 2 +- .../userspace-api/media/rc/lirc-get-rec-resolution.rst | 2 +- Documentation/userspace-api/media/rc/lirc-get-send-mode.rst | 2 +- Documentation/userspace-api/media/rc/lirc-get-timeout.rst | 2 +- Documentation/userspace-api/media/rc/lirc-header.rst | 2 +- Documentation/userspace-api/media/rc/lirc-read.rst | 2 +- .../userspace-api/media/rc/lirc-set-measure-carrier-mode.rst | 2 +- .../userspace-api/media/rc/lirc-set-rec-carrier-range.rst | 2 +- Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst | 2 +- .../userspace-api/media/rc/lirc-set-rec-timeout-reports.rst | 2 +- Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst | 2 +- Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst | 2 +- .../userspace-api/media/rc/lirc-set-send-duty-cycle.rst | 2 +- .../userspace-api/media/rc/lirc-set-transmitter-mask.rst | 2 +- .../userspace-api/media/rc/lirc-set-wideband-receiver.rst | 2 +- Documentation/userspace-api/media/rc/lirc-write.rst | 2 +- Documentation/userspace-api/media/rc/rc-intro.rst | 2 +- Documentation/userspace-api/media/rc/rc-protos.rst | 2 +- Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst | 2 +- Documentation/userspace-api/media/rc/rc-table-change.rst | 2 +- Documentation/userspace-api/media/rc/rc-tables.rst | 2 +- Documentation/userspace-api/media/rc/remote_controllers.rst | 2 +- 27 files changed, 27 insertions(+), 27 deletions(-)
Documentation/userspace-api/media/rc/keytable.c.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later file: uapi/v4l/keytable.c =========================
Documentation/userspace-api/media/rc/lirc-dev-intro.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. _lirc_dev_intro:
Documentation/userspace-api/media/rc/lirc-dev.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. _lirc_dev:
Documentation/userspace-api/media/rc/lirc-func.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. _lirc_func:
Documentation/userspace-api/media/rc/lirc-get-features.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_get_features:
Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_get_rec_mode:
Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_get_rec_resolution:
Documentation/userspace-api/media/rc/lirc-get-send-mode.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_get_send_mode:
Documentation/userspace-api/media/rc/lirc-get-timeout.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_get_min_timeout:
Documentation/userspace-api/media/rc/lirc-header.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. _lirc_header:
Documentation/userspace-api/media/rc/lirc-read.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc-read:
Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_set_measure_carrier_mode:
Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_set_rec_carrier_range:
Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_set_rec_carrier:
Documentation/userspace-api/media/rc/lirc-set-rec-timeout-reports.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_set_rec_timeout_reports:
Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_set_rec_timeout:
Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_set_send_carrier:
Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_set_send_duty_cycle:
Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_set_transmitter_mask:
Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc_set_wideband_receiver:
Documentation/userspace-api/media/rc/lirc-write.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. c:namespace:: RC .. _lirc-write:
Documentation/userspace-api/media/rc/rc-intro.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. _Remote_controllers_Intro:
Documentation/userspace-api/media/rc/rc-protos.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. _Remote_controllers_Protocols:
Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. _remote_controllers_sysfs_nodes:
Documentation/userspace-api/media/rc/rc-table-change.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. _Remote_controllers_table_change:
Documentation/userspace-api/media/rc/rc-tables.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. _Remote_controllers_tables:
Documentation/userspace-api/media/rc/remote_controllers.rst +1 -1
@@ -1,4 +1,4 @@ -.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later +.. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later .. include:: <isonum.txt> .. _remote_controllers:
Signature · 1 line
2.28.0
PATCH 2/2 media: rc: improve LIRC documentation
In reply to Mauro Carvalho ChehabAdd documentation for enum rc_proto and struct lirc_scancode at the generated docs.
--- .../userspace-api/media/rc/lirc-dev-intro.rst | 11 +++++++++-- include/uapi/linux/lirc.h | 2 +- 2 files changed, 10 insertions(+), 3 deletions(-)
Documentation/userspace-api/media/rc/lirc-dev-intro.rst +9 -2
@@ -57,12 +57,12 @@ on the following table. This mode is for both sending and receiving IR. - For transmitting (aka sending), create a ``struct lirc_scancode`` with + For transmitting (aka sending), create a struct lirc_scancode with the desired scancode set in the ``scancode`` member, :c:type:`rc_proto` set to the :ref:`IR protocol <Remote_controllers_Protocols>`, and all other members set to 0. Write this struct to the lirc device. - For receiving, you read ``struct lirc_scancode`` from the LIRC device. + For receiving, you read struct lirc_scancode from the LIRC device. The ``scancode`` field is set to the received scancode and the :ref:`IR protocol <Remote_controllers_Protocols>` is set in :c:type:`rc_proto`. If the scancode maps to a valid key code, this is set
@@ -136,6 +136,13 @@ on the following table. This mode is used only for IR send. +************************************* +Data types used by LIRC_MODE_SCANCODE +************************************* + +.. kernel-doc:: include/uapi/linux/lirc.h + :identifiers: lirc_scancode rc_proto + ******************** BPF based IR decoder ********************
include/uapi/linux/lirc.h +1 -1
@@ -139,7 +139,7 @@*/ #define LIRC_GET_REC_TIMEOUT _IOR('i', 0x00000024, __u32) -/* +/** * struct lirc_scancode - decoded scancode with protocol for use with * LIRC_MODE_SCANCODE *
Signature · 1 line
2.28.0
Sean Young
maintainerQuoted 6 lines · Mauro Carvalho Chehab
Hi Sean,
Those two patches improve LIRC uAPI docs by adding the structs documented at
lirc.hto the output ofDocumentation/output/userspace-api/media/rc/lirc-dev-intro.htmlPlease review.
Thanks,
For the series:
Quoted 38 lines
Mauro Carvalho Chehab (2):
media: docs: uAPI: rc: dual-license the docs with GPL v2
media: rc: improve LIRC documentationDocumentation/userspace-api/media/rc/keytable.c.rst | 2 +- .../userspace-api/media/rc/lirc-dev-intro.rst | 13 ++++++++++--- Documentation/userspace-api/media/rc/lirc-dev.rst | 2 +- Documentation/userspace-api/media/rc/lirc-func.rst | 2 +- .../userspace-api/media/rc/lirc-get-features.rst | 2 +- .../userspace-api/media/rc/lirc-get-rec-mode.rst | 2 +- .../media/rc/lirc-get-rec-resolution.rst | 2 +- .../userspace-api/media/rc/lirc-get-send-mode.rst | 2 +- .../userspace-api/media/rc/lirc-get-timeout.rst | 2 +- .../userspace-api/media/rc/lirc-header.rst | 2 +- Documentation/userspace-api/media/rc/lirc-read.rst | 2 +- .../media/rc/lirc-set-measure-carrier-mode.rst | 2 +- .../media/rc/lirc-set-rec-carrier-range.rst | 2 +- .../userspace-api/media/rc/lirc-set-rec-carrier.rst | 2 +- .../media/rc/lirc-set-rec-timeout-reports.rst | 2 +- .../userspace-api/media/rc/lirc-set-rec-timeout.rst | 2 +- .../media/rc/lirc-set-send-carrier.rst | 2 +- .../media/rc/lirc-set-send-duty-cycle.rst | 2 +- .../media/rc/lirc-set-transmitter-mask.rst | 2 +- .../media/rc/lirc-set-wideband-receiver.rst | 2 +- Documentation/userspace-api/media/rc/lirc-write.rst | 2 +- Documentation/userspace-api/media/rc/rc-intro.rst | 2 +- Documentation/userspace-api/media/rc/rc-protos.rst | 2 +- .../userspace-api/media/rc/rc-sysfs-nodes.rst | 2 +- .../userspace-api/media/rc/rc-table-change.rst | 2 +- Documentation/userspace-api/media/rc/rc-tables.rst | 2 +- .../userspace-api/media/rc/remote_controllers.rst | 2 +- include/uapi/linux/lirc.h | 2 +- 28 files changed, 37 insertions(+), 30 deletions(-)Signature · 1 line
2.28.0