linux-kernel - [PATCH RFC v2 1/3] docs: media: Create separate documentation folder for media

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20240529-b4-media_docs_improve-v2-1-66318b2da726@collabora.com>
Date: Tue, 24 Sep 2024 10:45:57 +0200
From: Sebastian Fricke <sebastian.fricke@...labora.com>
To: Jonathan Corbet <corbet@....net>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 linux-media@...r.kernel.org, laurent.pinchart@...asonboard.com,
 hverkuil-cisco@...all.nl, mauro.chehab@...ux.intel.com, kernel@...labora.com,
 bob.beckett@...labora.com, nicolas.dufresne@...labora.com,
 Sebastian Fricke <sebastian.fricke@...labora.com>
Subject: [PATCH RFC v2 1/3] docs: media: Create separate documentation folder
 for media

The media subsystem currently only maintains a set of Kernel API
documentations, with the intent of adding guides for the subsystem a
separate location is required. Create an empty folder with an index and
embed it into the subsystem listing.

Signed-off-by: Sebastian Fricke <sebastian.fricke@...labora.com>
---
 Documentation/media/index.rst    | 19 +++++++++++++++++++
 Documentation/subsystem-apis.rst |  1 +
 2 files changed, 20 insertions(+)

diff --git a/Documentation/media/index.rst b/Documentation/media/index.rst
new file mode 100644
index 000000000000..d056a9e99dca
--- /dev/null
+++ b/Documentation/media/index.rst
@@ -0,0 +1,19 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=============================
+Media Subsystem Documentation
+=============================
+
+.. toctree::
+   :maxdepth: 2
+
+   ../userspace-api/media/index
+   ../driver-api/media/index.rst
+   ../admin-guide/media/index
+
+.. only::  subproject and html
+
+   Indices
+   =======
+
+   * :ref:`genindex`
diff --git a/Documentation/subsystem-apis.rst b/Documentation/subsystem-apis.rst
index 74af50d2ef7f..5a1d90fd1af6 100644
--- a/Documentation/subsystem-apis.rst
+++ b/Documentation/subsystem-apis.rst
@@ -33,6 +33,7 @@ Human interfaces
    input/index
    hid/index
    sound/index
+   media/index
    gpu/index
    fb/index
    leds/index

-- 
2.25.1