Skip to content

Improve LIRC documentation

Mauro Carvalho Chehab linux-media 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest20 patches 7 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/20doc-rst: Document ioctl LIRC_GET_FEATURESDocumentation/media/lirc.h.rst.exceptions Documentation/media/uapi/rc/lirc-get-features.rst Documentation/media/uapi/rc/lirc_device_interface.rst +1 more+169 -430 replies
2/20doc-rst: add media/uapi/rc/lirc-header.rstDocumentation/media/uapi/rc/lirc-header.rst+10 -00 replies
3/20lirc.h: remove several unused ioctlsinclude/uapi/linux/lirc.h+2 -375 replies
4/20doc-rst: remove not used ioctls from documentationDocumentation/media/uapi/rc/lirc-get-features.rst Documentation/media/uapi/rc/lirc_ioctl.rst+9 -740 replies
5/20doc-rst: Fix LIRC_GET_FEATURES referencesDocumentation/media/lirc.h.rst.exceptions Documentation/media/uapi/rc/lirc-get-features.rst+60 -390 replies
6/20doc-rst: document ioctl LIRC_GET_SEND_MODEDocumentation/media/uapi/rc/lirc-get-send-mode.rst Documentation/media/uapi/rc/lirc_device_interface.rst Documentation/media/uapi/rc/lirc_ioctl.rst+49 -90 replies
7/20doc-rst: fix some lirc cross-referencesDocumentation/media/uapi/rc/lirc-get-features.rst Documentation/media/uapi/rc/lirc-get-send-mode.rst Documentation/media/uapi/rc/lirc_read.rst +1 more+6 -70 replies
8/20doc-rst: document ioctl LIRC_GET_REC_MODEDocumentation/media/uapi/rc/lirc-get-rec-mode.rst Documentation/media/uapi/rc/lirc_device_interface.rst Documentation/media/uapi/rc/lirc_ioctl.rst+60 -92 replies
9/20doc-rst: document LIRC_GET_REC_RESOLUTIONDocumentation/media/uapi/rc/lirc-get-rec-resolution.rst Documentation/media/uapi/rc/lirc_device_interface.rst Documentation/media/uapi/rc/lirc_ioctl.rst+50 -100 replies
10/20doc-rst: document LIRC_SET_SEND_DUTY_CYCLEDocumentation/media/uapi/rc/lirc-set-send-duty-cycle.rst Documentation/media/uapi/rc/lirc_device_interface.rst Documentation/media/uapi/rc/lirc_ioctl.rst+50 -90 replies
11/20doc-rst: document LIRC_GET_*_TIMEOUT ioctlsDocumentation/media/uapi/rc/lirc-get-timeout.rst Documentation/media/uapi/rc/lirc_device_interface.rst Documentation/media/uapi/rc/lirc_ioctl.rst+56 -130 replies
12/20doc-rst: Document LIRC_GET_LENGTH ioctlDocumentation/media/uapi/rc/lirc-get-length.rst Documentation/media/uapi/rc/lirc_device_interface.rst Documentation/media/uapi/rc/lirc_ioctl.rst+46 -110 replies
13/20doc-rst: document LIRC set carrier ioctlsDocumentation/media/uapi/rc/lirc-set-rec-carrier-range.rst Documentation/media/uapi/rc/lirc-set-rec-carrier.rst Documentation/media/uapi/rc/lirc-set-send-carrier.rst +2 more+143 -180 replies
14/20doc-rst: document LIRC_SET_TRANSMITTER_MASKDocumentation/media/uapi/rc/lirc-set-transmitter-mask.rst Documentation/media/uapi/rc/lirc_device_interface.rst Documentation/media/uapi/rc/lirc_ioctl.rst+54 -100 replies
15/20doc-rst: document LIRC_SET_REC_TIMEOUTDocumentation/media/uapi/rc/lirc-set-rec-timeout.rst Documentation/media/uapi/rc/lirc_device_interface.rst Documentation/media/uapi/rc/lirc_ioctl.rst+53 -110 replies
16/20doc-rst: document LIRC_SET_REC_TIMEOUT_REPORTSDocumentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst Documentation/media/uapi/rc/lirc_device_interface.rst Documentation/media/uapi/rc/lirc_ioctl.rst+50 -80 replies
17/20doc-rst: add documentation for LIRC_SET_MEASURE_CARRIER_MODEDocumentation/media/uapi/rc/lirc-set-measure-carrier-mode.rst Documentation/media/uapi/rc/lirc_device_interface.rst Documentation/media/uapi/rc/lirc_ioctl.rst+49 -90 replies
18/20doc-rst: document LIRC_SET_WIDEBAND_RECEIVERDocumentation/media/uapi/rc/lirc-set-wideband-receiver.rst Documentation/media/uapi/rc/lirc_device_interface.rst Documentation/media/uapi/rc/lirc_ioctl.rst+57 -190 replies
19/20doc-rst: Document LIRC set mode ioctlsDocumentation/media/uapi/rc/lirc-get-rec-mode.rst Documentation/media/uapi/rc/lirc-get-send-mode.rst Documentation/media/uapi/rc/lirc_dev_intro.rst +2 more+50 -980 replies
20/20doc-rst: reorganize LIRC ReST filesDocumentation/media/uapi/rc/lirc-dev-intro.rst Documentation/media/uapi/rc/lirc-dev.rst Documentation/media/uapi/rc/lirc-func.rst +3 more+24 -120 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 00/20] Improve LIRC documentation

The LIRC documentation doesn't follow the remaining of the media book.

There's just a single page with all ioctls inside, and, IMHO, not very clear. Also, the LIRC_CAN flags were not described.

This patchset address these. Also, it removes some LIRC ioctls that aren't used.

Mauro Carvalho Chehab (20):
[media] doc-rst: Document ioctl LIRC_GET_FEATURES
[media] doc-rst: add media/uapi/rc/lirc-header.rst [media] lirc.h: remove several unused ioctls
[media] doc-rst: remove not used ioctls from documentation [media] doc-rst: Fix LIRC_GET_FEATURES references
[media] doc-rst: document ioctl LIRC_GET_SEND_MODE [media] doc-rst: fix some lirc cross-references
[media] doc-rst: document ioctl LIRC_GET_REC_MODE
[media] doc-rst: document LIRC_GET_REC_RESOLUTION
[media] doc-rst: document LIRC_SET_SEND_DUTY_CYCLE [media] doc-rst: document LIRC_GET_*_TIMEOUT ioctls [media] doc-rst: Document LIRC_GET_LENGTH ioctl
[media] doc-rst: document LIRC set carrier ioctls
[media] doc-rst: document LIRC_SET_TRANSMITTER_MASK [media] doc-rst: document LIRC_SET_REC_TIMEOUT
[media] doc-rst: document LIRC_SET_REC_TIMEOUT_REPORTS [media] doc-rst: add documentation for LIRC_SET_MEASURE_CARRIER_MODE [media] doc-rst: document LIRC_SET_WIDEBAND_RECEIVER [media] doc-rst: Document LIRC set mode ioctls
[media] doc-rst: reorganize LIRC ReST files

 Documentation/media/lirc.h.rst.exceptions          |  39 +--
 .../rc/{lirc_dev_intro.rst => lirc-dev-intro.rst}  |  34 +++
 .../rc/{lirc_device_interface.rst => lirc-dev.rst} |   7 +-
 Documentation/media/uapi/rc/lirc-func.rst          |  28 +++
 Documentation/media/uapi/rc/lirc-get-features.rst  | 181 ++++++++++++++
 Documentation/media/uapi/rc/lirc-get-length.rst    |  45 ++++
 Documentation/media/uapi/rc/lirc-get-rec-mode.rst  |  45 ++++
 .../media/uapi/rc/lirc-get-rec-resolution.rst      |  49 ++++
 Documentation/media/uapi/rc/lirc-get-send-mode.rst |  45 ++++
 Documentation/media/uapi/rc/lirc-get-timeout.rst   |  55 +++++
 Documentation/media/uapi/rc/lirc-header.rst        |  10 +
 .../media/uapi/rc/{lirc_read.rst => lirc-read.rst} |  10 +-
 .../uapi/rc/lirc-set-measure-carrier-mode.rst      |  48 ++++
 .../media/uapi/rc/lirc-set-rec-carrier-range.rst   |  49 ++++
 .../media/uapi/rc/lirc-set-rec-carrier.rst         |  48 ++++
 .../media/uapi/rc/lirc-set-rec-timeout-reports.rst |  49 ++++
 .../media/uapi/rc/lirc-set-rec-timeout.rst         |  52 ++++
 .../media/uapi/rc/lirc-set-send-carrier.rst        |  43 ++++
 .../media/uapi/rc/lirc-set-send-duty-cycle.rst     |  49 ++++
 .../media/uapi/rc/lirc-set-transmitter-mask.rst    |  53 ++++
 .../media/uapi/rc/lirc-set-wideband-receiver.rst   |  56 +++++
 .../uapi/rc/{lirc_write.rst => lirc-write.rst}     |   4 +-
 Documentation/media/uapi/rc/lirc_ioctl.rst         | 270 ---------------------
 Documentation/media/uapi/rc/remote_controllers.rst |   3 +-
 include/uapi/linux/lirc.h                          |  39 +--
 25 files changed, 956 insertions(+), 355 deletions(-)
 rename Documentation/media/uapi/rc/{lirc_dev_intro.rst => lirc-dev-intro.rst} (52%)
 rename Documentation/media/uapi/rc/{lirc_device_interface.rst => lirc-dev.rst} (67%)
 create mode 100644 Documentation/media/uapi/rc/lirc-func.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-get-features.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-get-length.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-get-rec-mode.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-get-rec-resolution.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-get-send-mode.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-get-timeout.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-header.rst
 rename Documentation/media/uapi/rc/{lirc_read.rst => lirc-read.rst} (83%)
 create mode 100644 Documentation/media/uapi/rc/lirc-set-measure-carrier-mode.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-set-rec-carrier-range.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-set-rec-carrier.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-set-rec-timeout.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-set-send-carrier.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-set-send-duty-cycle.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-set-transmitter-mask.rst
 create mode 100644 Documentation/media/uapi/rc/lirc-set-wideband-receiver.rst
 rename Documentation/media/uapi/rc/{lirc_write.rst => lirc-write.rst} (94%)
 delete mode 100644 Documentation/media/uapi/rc/lirc_ioctl.rst
Signature · 1 line
2.7.4