linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sebastian Fricke <sebastian.fricke@collabora.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-media@vger.kernel.org, laurent.pinchart@ideasonboard.com,
	hverkuil-cisco@xs4all.nl, mauro.chehab@linux.intel.com,
	kernel@collabora.com,
	Sebastian Fricke <sebastian.fricke@collabora.com>
Subject: [PATCH RFC 1/2] docs: media: Create separate documentation folder for media
Date: Wed, 29 May 2024 18:22:56 +0200	[thread overview]
Message-ID: <20240529-b4-media_docs_improve-v1-1-9ddb111c4433@collabora.com> (raw)
In-Reply-To: <20240529-b4-media_docs_improve-v1-0-9ddb111c4433@collabora.com>

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@collabora.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

  reply	other threads:[~2024-05-29 16:23 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-29 16:22 [PATCH RFC 0/2] Documentation: Debugging guide Sebastian Fricke
2024-05-29 16:22 ` Sebastian Fricke [this message]
2024-05-29 16:22 ` [PATCH RFC 2/2] docs: media: Debugging guide for the media subsystem Sebastian Fricke
2024-06-24 11:23   ` Hans Verkuil
2024-06-28 22:15     ` Laurent Pinchart
2024-06-28 19:08   ` Adrian Larumbe
2024-06-28 19:34     ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240529-b4-media_docs_improve-v1-1-9ddb111c4433@collabora.com \
    --to=sebastian.fricke@collabora.com \
    --cc=corbet@lwn.net \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=kernel@collabora.com \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mauro.chehab@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).