summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2020-03-31 14:44:56 +0200
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>2020-04-15 15:51:24 +0200
commit63735af86d645a47903f912ae89957507edd917b (patch)
tree73993f9338ceb5b4123cf70876c7c170e0c3eb96
parente4da97eb3a0969e240a276562b45fb1ba2a343a3 (diff)
downloadlinux-63735af86d645a47903f912ae89957507edd917b.tar.gz
linux-63735af86d645a47903f912ae89957507edd917b.tar.bz2
linux-63735af86d645a47903f912ae89957507edd917b.zip
media: docs: add cros-references to the other media guides
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>
-rw-r--r--Documentation/admin-guide/media/index.rst12
-rw-r--r--Documentation/driver-api/media/index.rst8
-rw-r--r--Documentation/userspace-api/media/index.rst11
3 files changed, 31 insertions, 0 deletions
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