media: admin-guide: reorganize the guide

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>

diff --git a/Documentation/admin-guide/media/dvb.rst b/Documentation/admin-guide/media/dvb.rst
new file mode 100644 (file)
index 0000000..e5258bf
--- /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 dbe36e427e6ba304f2cb5fa45a983ac66207f71c..05ddd493069943d1387fac5f1e457acce4a9cf5d 100644 (file)
--- 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 ce23c8a7bc9385ad360fa30897de7953eaa44854..fa05410c3cd5e48608034e6263e03bcd8cbedc88 100644 (file)
--- 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,