diff mbox series

[19/19] media: docs: add cros-references to the other media guides

Message ID 47cda41623dbb81d65fc22be92266df3efc1c328.1586854191.git.mchehab+huawei@kernel.org
State New
Headers show
Series media: some documentation updates | expand

Commit Message

Mauro Carvalho Chehab April 14, 2020, 8:51 a.m. UTC 
In order to make easier for people to navigate between the
three media guides, add cross-references between them

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/admin-guide/media/index.rst   | 12 ++++++++++++
 Documentation/driver-api/media/index.rst    |  8 ++++++++
 Documentation/userspace-api/media/index.rst | 11 +++++++++++
 3 files changed, 31 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/admin-guide/media/index.rst b/Documentation/admin-guide/media/index.rst
index eb1d82dffcc9..6e5e6bdb6d4b 100644
--- a/Documentation/admin-guide/media/index.rst
+++ b/Documentation/admin-guide/media/index.rst
@@ -2,9 +2,21 @@ 
 
 .. include:: <isonum.txt>
 
+============================
+Media subsystem usage guides
+============================
 
+This section contains usage information about media subsystem and
+its supported drivers.
 
+Please see:
 
+- :doc:`/userspace-api/media/index`
+     for the userspace APIs used on media devices.
+
+- :doc:`/driver-api/media/index`
+     for driver development information and Kernel APIs used by
+     media devices;
 
 .. _uapi-v4l-drivers:
 
diff --git a/Documentation/driver-api/media/index.rst b/Documentation/driver-api/media/index.rst
index 5e9f67f34081..328350924853 100644
--- a/Documentation/driver-api/media/index.rst
+++ b/Documentation/driver-api/media/index.rst
@@ -6,8 +6,16 @@ 
 Media subsystem kernel internal API
 ===================================
 
+This section contains usage information about media subsystem and
+its supported drivers.
 
+Please see:
 
+- :doc:`/admin-guide/media/index`
+    for usage information about media subsystem and supported drivers;
+
+- :doc:`/userspace-api/media/index`
+     for the userspace APIs used on media devices.
 
 
 .. only:: html
diff --git a/Documentation/userspace-api/media/index.rst b/Documentation/userspace-api/media/index.rst
index b20010f414b3..70a3f3d73698 100644
--- a/Documentation/userspace-api/media/index.rst
+++ b/Documentation/userspace-api/media/index.rst
@@ -6,6 +6,17 @@ 
 Linux Media Infrastructure userspace API
 ########################################
 
+This section contains the  driver development information and Kernel APIs
+used by media devices.
+
+Please see:
+
+- :doc:`/admin-guide/media/index`
+    for usage information about media subsystem and supported drivers;
+
+- :doc:`/driver-api/media/index`
+     for driver development information and Kernel APIs used by
+     media devices;
 
 
 .. only:: html