[PATCH 0/2] Improve LIRC documentation

public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed

* [PATCH 0/2] Improve LIRC documentation
@ 2020-11-26 13:00 Mauro Carvalho Chehab
  2020-11-26 13:00 ` [PATCH 1/2] media: docs: uAPI: rc: dual-license the docs with GPL v2 Mauro Carvalho Chehab
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2020-11-26 13:00 UTC (permalink / raw)
  To: Linux Media Mailing List, Sean Young
  Cc: linuxarm, mauro.chehab, Mauro Carvalho Chehab,
	Mauro Carvalho Chehab, linux-kernel

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(-)

-- 
2.28.0



^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH 1/2] media: docs: uAPI: rc: dual-license the docs with GPL v2
  2020-11-26 13:00 [PATCH 0/2] Improve LIRC documentation Mauro Carvalho Chehab
@ 2020-11-26 13:00 ` Mauro Carvalho Chehab
  2020-11-26 13:00 ` [PATCH 2/2] media: rc: improve LIRC documentation Mauro Carvalho Chehab
  2020-11-26 13:13 ` [PATCH 0/2] Improve " Sean Young
  2 siblings, 0 replies; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2020-11-26 13:00 UTC (permalink / raw)
  To: Linux Media Mailing List, Sean Young
  Cc: linuxarm, mauro.chehab, Mauro Carvalho Chehab,
	Mauro Carvalho Chehab, linux-kernel

Make the license for those documents also compatible with GPLv2.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 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(-)

diff --git a/Documentation/userspace-api/media/rc/keytable.c.rst b/Documentation/userspace-api/media/rc/keytable.c.rst
index 0b50cfaf2d86..243e02d2611f 100644
--- a/Documentation/userspace-api/media/rc/keytable.c.rst
+++ b/Documentation/userspace-api/media/rc/keytable.c.rst
@@ -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
 =========================
diff --git a/Documentation/userspace-api/media/rc/lirc-dev-intro.rst b/Documentation/userspace-api/media/rc/lirc-dev-intro.rst
index 167b354bf051..266b646d584e 100644
--- a/Documentation/userspace-api/media/rc/lirc-dev-intro.rst
+++ b/Documentation/userspace-api/media/rc/lirc-dev-intro.rst
@@ -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:
 
diff --git a/Documentation/userspace-api/media/rc/lirc-dev.rst b/Documentation/userspace-api/media/rc/lirc-dev.rst
index 5510dc02a822..978f86d30fae 100644
--- a/Documentation/userspace-api/media/rc/lirc-dev.rst
+++ b/Documentation/userspace-api/media/rc/lirc-dev.rst
@@ -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:
 
diff --git a/Documentation/userspace-api/media/rc/lirc-func.rst b/Documentation/userspace-api/media/rc/lirc-func.rst
index 420a3dbf0d6b..793f295d3ac9 100644
--- a/Documentation/userspace-api/media/rc/lirc-func.rst
+++ b/Documentation/userspace-api/media/rc/lirc-func.rst
@@ -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:
 
diff --git a/Documentation/userspace-api/media/rc/lirc-get-features.rst b/Documentation/userspace-api/media/rc/lirc-get-features.rst
index 66a243dbd437..4bf25860f932 100644
--- a/Documentation/userspace-api/media/rc/lirc-get-features.rst
+++ b/Documentation/userspace-api/media/rc/lirc-get-features.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst b/Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst
index 188478ed1233..628fe31792b2 100644
--- a/Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst
+++ b/Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst b/Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst
index e29445c5ce16..4dfa9c23634b 100644
--- a/Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst
+++ b/Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-get-send-mode.rst b/Documentation/userspace-api/media/rc/lirc-get-send-mode.rst
index 77472fb5608a..637871805be6 100644
--- a/Documentation/userspace-api/media/rc/lirc-get-send-mode.rst
+++ b/Documentation/userspace-api/media/rc/lirc-get-send-mode.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-get-timeout.rst b/Documentation/userspace-api/media/rc/lirc-get-timeout.rst
index f5f3e06d6206..597c3282ae12 100644
--- a/Documentation/userspace-api/media/rc/lirc-get-timeout.rst
+++ b/Documentation/userspace-api/media/rc/lirc-get-timeout.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-header.rst b/Documentation/userspace-api/media/rc/lirc-header.rst
index 8bd0acc9913a..54cb40b8a065 100644
--- a/Documentation/userspace-api/media/rc/lirc-header.rst
+++ b/Documentation/userspace-api/media/rc/lirc-header.rst
@@ -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:
 
diff --git a/Documentation/userspace-api/media/rc/lirc-read.rst b/Documentation/userspace-api/media/rc/lirc-read.rst
index d589560214f4..ce34318698b7 100644
--- a/Documentation/userspace-api/media/rc/lirc-read.rst
+++ b/Documentation/userspace-api/media/rc/lirc-read.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst b/Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst
index 9bf9811a905a..04ced1aa664b 100644
--- a/Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst
+++ b/Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst b/Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst
index 530bc223930a..7512dc86b03a 100644
--- a/Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst
+++ b/Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst b/Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst
index 28c928f1cc14..60e321446ea7 100644
--- a/Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst
+++ b/Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-set-rec-timeout-reports.rst b/Documentation/userspace-api/media/rc/lirc-set-rec-timeout-reports.rst
index 83e7155c5796..aebe81012939 100644
--- a/Documentation/userspace-api/media/rc/lirc-set-rec-timeout-reports.rst
+++ b/Documentation/userspace-api/media/rc/lirc-set-rec-timeout-reports.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst b/Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst
index 8f3f9adf54ab..bf9fb2cc61c3 100644
--- a/Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst
+++ b/Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst b/Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst
index e3810ba58746..a003f9447553 100644
--- a/Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst
+++ b/Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst b/Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst
index 52a072529af9..2979752acbcd 100644
--- a/Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst
+++ b/Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst b/Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst
index 68f4cc2e3ae3..38acbcd6e91c 100644
--- a/Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst
+++ b/Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst b/Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst
index be5321c4a91f..c9d578e291b8 100644
--- a/Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst
+++ b/Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/lirc-write.rst b/Documentation/userspace-api/media/rc/lirc-write.rst
index c1c3230d4fd6..970a8b3fa1ca 100644
--- a/Documentation/userspace-api/media/rc/lirc-write.rst
+++ b/Documentation/userspace-api/media/rc/lirc-write.rst
@@ -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:
diff --git a/Documentation/userspace-api/media/rc/rc-intro.rst b/Documentation/userspace-api/media/rc/rc-intro.rst
index 1338478e2bd4..2ba62cde2369 100644
--- a/Documentation/userspace-api/media/rc/rc-intro.rst
+++ b/Documentation/userspace-api/media/rc/rc-intro.rst
@@ -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:
 
diff --git a/Documentation/userspace-api/media/rc/rc-protos.rst b/Documentation/userspace-api/media/rc/rc-protos.rst
index 2e290584a210..a2eab3b45647 100644
--- a/Documentation/userspace-api/media/rc/rc-protos.rst
+++ b/Documentation/userspace-api/media/rc/rc-protos.rst
@@ -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:
 
diff --git a/Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst b/Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst
index 43c442696438..34d6a0a1f4d3 100644
--- a/Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst
+++ b/Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst
@@ -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:
 
diff --git a/Documentation/userspace-api/media/rc/rc-table-change.rst b/Documentation/userspace-api/media/rc/rc-table-change.rst
index 61c77b080ae8..d7de8a56ddfe 100644
--- a/Documentation/userspace-api/media/rc/rc-table-change.rst
+++ b/Documentation/userspace-api/media/rc/rc-table-change.rst
@@ -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:
 
diff --git a/Documentation/userspace-api/media/rc/rc-tables.rst b/Documentation/userspace-api/media/rc/rc-tables.rst
index 8dc11657fc23..aafbfda1f401 100644
--- a/Documentation/userspace-api/media/rc/rc-tables.rst
+++ b/Documentation/userspace-api/media/rc/rc-tables.rst
@@ -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:
 
diff --git a/Documentation/userspace-api/media/rc/remote_controllers.rst b/Documentation/userspace-api/media/rc/remote_controllers.rst
index 2d9078accb35..f89291838637 100644
--- a/Documentation/userspace-api/media/rc/remote_controllers.rst
+++ b/Documentation/userspace-api/media/rc/remote_controllers.rst
@@ -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:
-- 
2.28.0


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* [PATCH 2/2] media: rc: improve LIRC documentation
  2020-11-26 13:00 [PATCH 0/2] Improve LIRC documentation Mauro Carvalho Chehab
  2020-11-26 13:00 ` [PATCH 1/2] media: docs: uAPI: rc: dual-license the docs with GPL v2 Mauro Carvalho Chehab
@ 2020-11-26 13:00 ` Mauro Carvalho Chehab
  2020-11-26 13:13 ` [PATCH 0/2] Improve " Sean Young
  2 siblings, 0 replies; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2020-11-26 13:00 UTC (permalink / raw)
  To: Linux Media Mailing List, Sean Young
  Cc: linuxarm, mauro.chehab, Mauro Carvalho Chehab,
	Mauro Carvalho Chehab, linux-kernel

Add documentation for enum rc_proto and struct lirc_scancode
at the generated docs.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 .../userspace-api/media/rc/lirc-dev-intro.rst         | 11 +++++++++--
 include/uapi/linux/lirc.h                             |  2 +-
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/Documentation/userspace-api/media/rc/lirc-dev-intro.rst b/Documentation/userspace-api/media/rc/lirc-dev-intro.rst
index 266b646d584e..c88973732282 100644
--- a/Documentation/userspace-api/media/rc/lirc-dev-intro.rst
+++ b/Documentation/userspace-api/media/rc/lirc-dev-intro.rst
@@ -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
 ********************
diff --git a/include/uapi/linux/lirc.h b/include/uapi/linux/lirc.h
index bf0672a6d341..c45a4eaea667 100644
--- a/include/uapi/linux/lirc.h
+++ b/include/uapi/linux/lirc.h
@@ -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
  *
-- 
2.28.0


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH 0/2] Improve LIRC documentation
  2020-11-26 13:00 [PATCH 0/2] Improve LIRC documentation Mauro Carvalho Chehab
  2020-11-26 13:00 ` [PATCH 1/2] media: docs: uAPI: rc: dual-license the docs with GPL v2 Mauro Carvalho Chehab
  2020-11-26 13:00 ` [PATCH 2/2] media: rc: improve LIRC documentation Mauro Carvalho Chehab
@ 2020-11-26 13:13 ` Sean Young
  2 siblings, 0 replies; 4+ messages in thread
From: Sean Young @ 2020-11-26 13:13 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Media Mailing List, linuxarm, mauro.chehab,
	Mauro Carvalho Chehab, linux-kernel

On Thu, Nov 26, 2020 at 02:00:54PM +0100, Mauro Carvalho Chehab wrote:
> 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.

Thanks,

For the series:

Signed-off-by: Sean Young <sean@mess.org>

> 
> 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(-)
> 
> -- 
> 2.28.0
> 

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2020-11-26 13:13 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-11-26 13:00 [PATCH 0/2] Improve LIRC documentation Mauro Carvalho Chehab
2020-11-26 13:00 ` [PATCH 1/2] media: docs: uAPI: rc: dual-license the docs with GPL v2 Mauro Carvalho Chehab
2020-11-26 13:00 ` [PATCH 2/2] media: rc: improve LIRC documentation Mauro Carvalho Chehab
2020-11-26 13:13 ` [PATCH 0/2] Improve " Sean Young

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox