Improve LIRC documentation
Get series with b4
b4 am [email protected]Versions newest first
- v1 Latest20 patches 7 repliesIn review
Patches in v1 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/20 | doc-rst: Document ioctl LIRC_GET_FEATURESDocumentation/ Documentation/ Documentation/ +1 more | +169 | 0 replies | |
| 2/20 | doc-rst: add media/uapi/rc/lirc-header.rstDocumentation/ | +10 | 0 replies | |
| 3/20 | lirc.h: remove several unused ioctlsinclude/ | +2 | 5 replies | |
| 4/20 | doc-rst: remove not used ioctls from documentationDocumentation/ Documentation/ | +9 | 0 replies | |
| 5/20 | doc-rst: Fix LIRC_GET_FEATURES referencesDocumentation/ Documentation/ | +60 | 0 replies | |
| 6/20 | doc-rst: document ioctl LIRC_GET_SEND_MODEDocumentation/ Documentation/ Documentation/ | +49 | 0 replies | |
| 7/20 | doc-rst: fix some lirc cross-referencesDocumentation/ Documentation/ Documentation/ +1 more | +6 | 0 replies | |
| 8/20 | doc-rst: document ioctl LIRC_GET_REC_MODEDocumentation/ Documentation/ Documentation/ | +60 | 2 replies | |
| 9/20 | doc-rst: document LIRC_GET_REC_RESOLUTIONDocumentation/ Documentation/ Documentation/ | +50 | 0 replies | |
| 10/20 | doc-rst: document LIRC_SET_SEND_DUTY_CYCLEDocumentation/ Documentation/ Documentation/ | +50 | 0 replies | |
| 11/20 | doc-rst: document LIRC_GET_*_TIMEOUT ioctlsDocumentation/ Documentation/ Documentation/ | +56 | 0 replies | |
| 12/20 | doc-rst: Document LIRC_GET_LENGTH ioctlDocumentation/ Documentation/ Documentation/ | +46 | 0 replies | |
| 13/20 | doc-rst: document LIRC set carrier ioctlsDocumentation/ Documentation/ Documentation/ +2 more | +143 | 0 replies | |
| 14/20 | doc-rst: document LIRC_SET_TRANSMITTER_MASKDocumentation/ Documentation/ Documentation/ | +54 | 0 replies | |
| 15/20 | doc-rst: document LIRC_SET_REC_TIMEOUTDocumentation/ Documentation/ Documentation/ | +53 | 0 replies | |
| 16/20 | doc-rst: document LIRC_SET_REC_TIMEOUT_REPORTSDocumentation/ Documentation/ Documentation/ | +50 | 0 replies | |
| 17/20 | doc-rst: add documentation for LIRC_SET_MEASURE_CARRIER_MODEDocumentation/ Documentation/ Documentation/ | +49 | 0 replies | |
| 18/20 | doc-rst: document LIRC_SET_WIDEBAND_RECEIVERDocumentation/ Documentation/ Documentation/ | +57 | 0 replies | |
| 19/20 | doc-rst: Document LIRC set mode ioctlsDocumentation/ Documentation/ Documentation/ +2 more | +50 | 0 replies | |
| 20/20 | doc-rst: reorganize LIRC ReST filesDocumentation/ Documentation/ Documentation/ +3 more | +24 | 0 replies |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.
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.rstSignature · 1 line
2.7.4