[PATCH 0/3] Reorg the media admin-guide

[PATCH 0/3] Reorg the media admin-guide

[Mauro Carvalho Chehab]

Change numberation and chapter order at the media-admin guide,
in order to place generic documents before driver-specific ones.

Mauro Carvalho Chehab (3):
  media: admin-guide: bt8xx.rst: fix a broken cross-reference
  media: admin-guide: reorganize the guide
  media: admin-guide: split driver-specific indexes to new files

 Documentation/admin-guide/media/bt8xx.rst     |  2 +-
 .../admin-guide/media/cec-drivers.rst         | 10 +++
 .../admin-guide/media/dvb-drivers.rst         | 16 ++++
 Documentation/admin-guide/media/dvb.rst       | 12 +++
 Documentation/admin-guide/media/index.rst     | 89 +++----------------
 ...{v4l-with-ir.rst => remote-controller.rst} |  9 +-
 .../admin-guide/media/v4l-drivers.rst         | 33 +++++++
 7 files changed, 90 insertions(+), 81 deletions(-)
 create mode 100644 Documentation/admin-guide/media/cec-drivers.rst
 create mode 100644 Documentation/admin-guide/media/dvb-drivers.rst
 create mode 100644 Documentation/admin-guide/media/dvb.rst
 rename Documentation/admin-guide/media/{v4l-with-ir.rst => remote-controller.rst} (96%)
 create mode 100644 Documentation/admin-guide/media/v4l-drivers.rst

-- 
2.25.2

[PATCH 1/3] media: admin-guide: bt8xx.rst: fix a broken cross-reference

[Mauro Carvalho Chehab]

The old cards.rst file doesn't exist anymore. Also, it is not
the right reference there, as it should be pointing to the
bttv-specific cardlist.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/admin-guide/media/bt8xx.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/media/bt8xx.rst b/Documentation/admin-guide/media/bt8xx.rst
index a55f4f5af042..d6cf81d83d61 100644
--- a/Documentation/admin-guide/media/bt8xx.rst
+++ b/Documentation/admin-guide/media/bt8xx.rst
@@ -18,7 +18,7 @@ General information
 This class of cards has a bt878a as the PCI interface, and require the bttv driver
 for accessing the i2c bus and the gpio pins of the bt8xx chipset.
 
-Please see :doc:`cards` for a complete list of Cards based on the
+Please see :doc:`bttv-cardlist` for a complete list of Cards based on the
 Conexant Bt8xx PCI bridge supported by the Linux Kernel.
 
 In order to be able to compile the kernel, some config options should be
-- 
2.25.2

[PATCH 2/3] media: admin-guide: reorganize the guide

[Mauro Carvalho Chehab]

Separate the generic documentation from the driver-specific
parts, and use a better title for the documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/admin-guide/media/dvb.rst       | 12 +++++
 Documentation/admin-guide/media/index.rst     | 46 +++++++++++--------
 ...{v4l-with-ir.rst => remote-controller.rst} |  9 ++--
 3 files changed, 44 insertions(+), 23 deletions(-)
 create mode 100644 Documentation/admin-guide/media/dvb.rst
 rename Documentation/admin-guide/media/{v4l-with-ir.rst => remote-controller.rst} (96%)

diff --git a/Documentation/admin-guide/media/dvb.rst b/Documentation/admin-guide/media/dvb.rst
new file mode 100644
index 000000000000..e5258bfa5cd9
--- /dev/null
+++ b/Documentation/admin-guide/media/dvb.rst
@@ -0,0 +1,12 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==========
+Digital TV
+==========
+
+.. toctree::
+
+	dvb_intro
+	ci
+	faq
+	dvb_references
diff --git a/Documentation/admin-guide/media/index.rst b/Documentation/admin-guide/media/index.rst
index dbe36e427e6b..05ddd4930699 100644
--- a/Documentation/admin-guide/media/index.rst
+++ b/Documentation/admin-guide/media/index.rst
@@ -2,9 +2,9 @@
 
 .. include:: <isonum.txt>
 
-============================
-Media subsystem usage guides
-============================
+====================================
+Media subsystem admin and user guide
+====================================
 
 This section contains usage information about media subsystem and
 its supported drivers.
@@ -18,11 +18,8 @@ Please see:
      for driver development information and Kernel APIs used by
      media devices;
 
-.. _uapi-v4l-drivers:
-
-################################################
-Video4Linux (V4L)  driver-specific documentation
-################################################
+The media subsystem
+===================
 
 .. only:: html
 
@@ -37,9 +34,27 @@ Video4Linux (V4L)  driver-specific documentation
 	intro
 	building
 
+	remote-controller
+
+	dvb
+
 	cardlist
 
-	v4l-with-ir
+
+.. _uapi-v4l-drivers:
+
+Video4Linux (V4L) driver-specific documentation
+===============================================
+
+.. only:: html
+
+    .. class:: toc-title
+
+        Table of Contents
+
+.. toctree::
+	:maxdepth: 5
+	:numbered:
 
 	bttv
 	cafe_ccic
@@ -64,9 +79,8 @@ Video4Linux (V4L)  driver-specific documentation
 	vimc
 	vivid
 
-##############################################
-Linux Digital TV driver-specific documentation
-##############################################
+Digital TV driver-specific documentation
+========================================
 
 .. only:: html
 
@@ -78,11 +92,6 @@ Linux Digital TV driver-specific documentation
 	:maxdepth: 5
 	:numbered:
 
-	dvb_intro
-	ci
-	faq
-	dvb_references
-
 	avermedia
 	bt8xx
 	lmedm04
@@ -91,9 +100,8 @@ Linux Digital TV driver-specific documentation
 	ttusb-dec
 	zr364xx
 
-#################################
 CEC driver-specific documentation
-#################################
+=================================
 
 .. only:: html
 
diff --git a/Documentation/admin-guide/media/v4l-with-ir.rst b/Documentation/admin-guide/media/remote-controller.rst
similarity index 96%
rename from Documentation/admin-guide/media/v4l-with-ir.rst
rename to Documentation/admin-guide/media/remote-controller.rst
index ce23c8a7bc93..fa05410c3cd5 100644
--- a/Documentation/admin-guide/media/v4l-with-ir.rst
+++ b/Documentation/admin-guide/media/remote-controller.rst
@@ -1,12 +1,13 @@
 .. SPDX-License-Identifier: GPL-2.0
 
+======================================================
 Infrared remote control support in video4linux drivers
 ======================================================
 
 Authors: Gerd Hoffmann, Mauro Carvalho Chehab
 
 Basics
-------
+======
 
 Most analog and digital TV boards support remote controllers. Several of
 them have a microprocessor that receives the IR carriers, convert into
@@ -33,7 +34,7 @@ detected. However, for a few devices, you need to manually load the
 ir-kbd-i2c module.
 
 How it works
-------------
+============
 
 The modules register the remote as keyboard within the linux input
 layer, i.e. you'll see the keys of the remote as normal key strokes
@@ -55,7 +56,7 @@ the keymaps, like the input kbd utility.
 
 
 Using with lircd
-================
+----------------
 
 The latest versions of the lircd daemon supports reading events from the
 linux input layer (via event device). It also supports receiving IR codes
@@ -63,7 +64,7 @@ in lirc mode.
 
 
 Using without lircd
-===================
+-------------------
 
 Xorg recognizes several IR keycodes that have its numerical value lower
 than 247. With the advent of Wayland, the input driver got updated too,
-- 
2.25.2

[PATCH 3/3] media: admin-guide: split driver-specific indexes to new files

[Mauro Carvalho Chehab]

In order to better organize the main admin-guide index,
place the driver-specific indexes on separate files.

This ensures a more consistent numbering at the main index.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 .../admin-guide/media/cec-drivers.rst         | 10 +++
 .../admin-guide/media/dvb-drivers.rst         | 16 ++++
 Documentation/admin-guide/media/index.rst     | 79 +------------------
 .../admin-guide/media/v4l-drivers.rst         | 33 ++++++++
 4 files changed, 63 insertions(+), 75 deletions(-)
 create mode 100644 Documentation/admin-guide/media/cec-drivers.rst
 create mode 100644 Documentation/admin-guide/media/dvb-drivers.rst
 create mode 100644 Documentation/admin-guide/media/v4l-drivers.rst

diff --git a/Documentation/admin-guide/media/cec-drivers.rst b/Documentation/admin-guide/media/cec-drivers.rst
new file mode 100644
index 000000000000..8d9686c08df9
--- /dev/null
+++ b/Documentation/admin-guide/media/cec-drivers.rst
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=================================
+CEC driver-specific documentation
+=================================
+
+.. toctree::
+	:maxdepth: 2
+
+	pulse8-cec
diff --git a/Documentation/admin-guide/media/dvb-drivers.rst b/Documentation/admin-guide/media/dvb-drivers.rst
new file mode 100644
index 000000000000..8df637c375f9
--- /dev/null
+++ b/Documentation/admin-guide/media/dvb-drivers.rst
@@ -0,0 +1,16 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+========================================
+Digital TV driver-specific documentation
+========================================
+
+.. toctree::
+	:maxdepth: 2
+
+	avermedia
+	bt8xx
+	lmedm04
+	opera-firmware
+	technisat
+	ttusb-dec
+	zr364xx
diff --git a/Documentation/admin-guide/media/index.rst b/Documentation/admin-guide/media/index.rst
index 05ddd4930699..6e0d2bae7154 100644
--- a/Documentation/admin-guide/media/index.rst
+++ b/Documentation/admin-guide/media/index.rst
@@ -28,7 +28,7 @@ The media subsystem
         Table of Contents
 
 .. toctree::
-	:maxdepth: 5
+	:maxdepth: 2
 	:numbered:
 
 	intro
@@ -40,80 +40,9 @@ The media subsystem
 
 	cardlist
 
-
-.. _uapi-v4l-drivers:
-
-Video4Linux (V4L) driver-specific documentation
-===============================================
-
-.. only:: html
-
-    .. class:: toc-title
-
-        Table of Contents
-
-.. toctree::
-	:maxdepth: 5
-	:numbered:
-
-	bttv
-	cafe_ccic
-	cpia2
-	cx88
-	davinci-vpbe
-	fimc
-	imx
-	imx7
-	ipu3
-	ivtv
-	meye
-	omap3isp
-	omap4_camera
-	philips
-	qcom_camss
-	rcar-fdp1
-	saa7134
-	si470x
-	si4713
-	si476x
-	vimc
-	vivid
-
-Digital TV driver-specific documentation
-========================================
-
-.. only:: html
-
-    .. class:: toc-title
-
-        Table of Contents
-
-.. toctree::
-	:maxdepth: 5
-	:numbered:
-
-	avermedia
-	bt8xx
-	lmedm04
-	opera-firmware
-	technisat
-	ttusb-dec
-	zr364xx
-
-CEC driver-specific documentation
-=================================
-
-.. only:: html
-
-    .. class:: toc-title
-
-        Table of Contents
-
-.. toctree::
-	:maxdepth: 5
-	:numbered:
-
-	pulse8-cec
+	v4l-drivers
+	dvb-drivers
+	cec-drivers
 
 **Copyright** |copy| 1999-2020 : LinuxTV Developers
 
diff --git a/Documentation/admin-guide/media/v4l-drivers.rst b/Documentation/admin-guide/media/v4l-drivers.rst
new file mode 100644
index 000000000000..251cc4ede0b6
--- /dev/null
+++ b/Documentation/admin-guide/media/v4l-drivers.rst
@@ -0,0 +1,33 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. _uapi-v4l-drivers:
+
+===============================================
+Video4Linux (V4L) driver-specific documentation
+===============================================
+
+.. toctree::
+	:maxdepth: 2
+
+	bttv
+	cafe_ccic
+	cpia2
+	cx88
+	davinci-vpbe
+	fimc
+	imx
+	imx7
+	ipu3
+	ivtv
+	meye
+	omap3isp
+	omap4_camera
+	philips
+	qcom_camss
+	rcar-fdp1
+	saa7134
+	si470x
+	si4713
+	si476x
+	vimc
+	vivid
-- 
2.25.2