public inbox for linux-media@vger.kernel.org
 help / color / mirror / Atom feed
From: Sakari Ailus <sakari.ailus@linux.intel.com>
To: linux-media@vger.kernel.org
Cc: laurent.pinchart@ideasonboard.com,
	Tianshu Qiu <tian.shu.qiu@intel.com>,
	Bingbu Cao <bingbu.cao@intel.com>,
	Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>,
	Jacopo Mondi <jacopo+renesas@jmondi.org>
Subject: [PATCH 1/7] media: Documentation: Align numbered list, make it a proper ReST
Date: Fri, 15 Sep 2023 10:28:03 +0300	[thread overview]
Message-ID: <20230915072809.37886-2-sakari.ailus@linux.intel.com> (raw)
In-Reply-To: <20230915072809.37886-1-sakari.ailus@linux.intel.com>

Align lines for numbered list so that Sphinx produces an uniform output
for all list entries. Also indent paragraphs of such list entries for
consistency.

Also use ReST numbered list syntax for the entries.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 .../userspace-api/media/v4l/dev-subdev.rst    | 49 +++++++++----------
 1 file changed, 24 insertions(+), 25 deletions(-)

diff --git a/Documentation/userspace-api/media/v4l/dev-subdev.rst b/Documentation/userspace-api/media/v4l/dev-subdev.rst
index a4f1df7093e8..43988516acdd 100644
--- a/Documentation/userspace-api/media/v4l/dev-subdev.rst
+++ b/Documentation/userspace-api/media/v4l/dev-subdev.rst
@@ -579,20 +579,19 @@ is started.
 
 There are three steps in configuring the streams:
 
-1) Set up links. Connect the pads between sub-devices using the :ref:`Media
-Controller API <media_controller>`
+1. Set up links. Connect the pads between sub-devices using the
+   :ref:`Media Controller API <media_controller>`
 
-2) Streams. Streams are declared and their routing is configured by
-setting the routing table for the sub-device using
-:ref:`VIDIOC_SUBDEV_S_ROUTING <VIDIOC_SUBDEV_G_ROUTING>` ioctl. Note that
-setting the routing table will reset formats and selections in the
-sub-device to default values.
+2. Streams. Streams are declared and their routing is configured by setting the
+   routing table for the sub-device using :ref:`VIDIOC_SUBDEV_S_ROUTING
+   <VIDIOC_SUBDEV_G_ROUTING>` ioctl. Note that setting the routing table will
+   reset formats and selections in the sub-device to default values.
 
-3) Configure formats and selections. Formats and selections of each stream
-are configured separately as documented for plain sub-devices in
-:ref:`format-propagation`. The stream ID is set to the same stream ID
-associated with either sink or source pads of routes configured using the
-:ref:`VIDIOC_SUBDEV_S_ROUTING <VIDIOC_SUBDEV_G_ROUTING>` ioctl.
+3. Configure formats and selections. Formats and selections of each stream are
+   configured separately as documented for plain sub-devices in
+   :ref:`format-propagation`. The stream ID is set to the same stream ID
+   associated with either sink or source pads of routes configured using the
+   :ref:`VIDIOC_SUBDEV_S_ROUTING <VIDIOC_SUBDEV_G_ROUTING>` ioctl.
 
 Multiplexed streams setup example
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -618,11 +617,11 @@ modeled as V4L2 devices, exposed to userspace via /dev/videoX nodes.
 
 To configure this pipeline, the userspace must take the following steps:
 
-1) Set up media links between entities: connect the sensors to the bridge,
-bridge to the receiver, and the receiver to the DMA engines. This step does
-not differ from normal non-multiplexed media controller setup.
+1. Set up media links between entities: connect the sensors to the bridge,
+   bridge to the receiver, and the receiver to the DMA engines. This step does
+   not differ from normal non-multiplexed media controller setup.
 
-2) Configure routing
+2. Configure routing
 
 .. flat-table:: Bridge routing table
     :header-rows:  1
@@ -656,14 +655,14 @@ not differ from normal non-multiplexed media controller setup.
       - V4L2_SUBDEV_ROUTE_FL_ACTIVE
       - Pixel data stream from Sensor B
 
-3) Configure formats and selections
+3. Configure formats and selections
 
-After configuring routing, the next step is configuring the formats and
-selections for the streams. This is similar to performing this step without
-streams, with just one exception: the ``stream`` field needs to be assigned
-to the value of the stream ID.
+   After configuring routing, the next step is configuring the formats and
+   selections for the streams. This is similar to performing this step without
+   streams, with just one exception: the ``stream`` field needs to be assigned
+   to the value of the stream ID.
 
-A common way to accomplish this is to start from the sensors and propagate the
-configurations along the stream towards the receiver,
-using :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctls to configure each
-stream endpoint in each sub-device.
+   A common way to accomplish this is to start from the sensors and propagate
+   the configurations along the stream towards the receiver, using
+   :ref:`VIDIOC_SUBDEV_S_FMT <VIDIOC_SUBDEV_G_FMT>` ioctls to configure each
+   stream endpoint in each sub-device.
-- 
2.39.2


  reply	other threads:[~2023-09-15  7:28 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-15  7:28 [PATCH 0/7] Small fixes and cleanups (ov2740 and ccs) Sakari Ailus
2023-09-15  7:28 ` Sakari Ailus [this message]
2023-09-15  9:17   ` [PATCH 1/7] media: Documentation: Align numbered list, make it a proper ReST Laurent Pinchart
2023-09-15  7:28 ` [PATCH 2/7] media: ccs: Fix driver quirk struct documentation Sakari Ailus
2023-09-15  9:18   ` Laurent Pinchart
2023-09-15  7:28 ` [PATCH 3/7] media: ccs: Correctly initialise try compose rectangle Sakari Ailus
2023-09-15  9:19   ` Laurent Pinchart
2023-09-15  9:48     ` Sakari Ailus
2023-09-15  7:28 ` [PATCH 4/7] media: ccs: Correct error handling in ccs_register_subdev Sakari Ailus
2023-09-15  9:33   ` Laurent Pinchart
2023-09-15  7:28 ` [PATCH 5/7] media: ov2740: Enable runtime PM before registering the async subdev Sakari Ailus
2023-09-15  9:42   ` Laurent Pinchart
2023-09-15 10:09     ` Sakari Ailus
2023-09-15 11:30       ` Laurent Pinchart
2023-09-15 11:48         ` Sakari Ailus
2023-09-15 12:16           ` Laurent Pinchart
2023-09-15 15:50             ` Sakari Ailus
2023-09-15 16:11               ` Laurent Pinchart
2023-09-15 20:31     ` Sakari Ailus
2023-09-15 20:39       ` Laurent Pinchart
2023-09-15  7:28 ` [PATCH 6/7] media: ov2740: Use sub-device active state Sakari Ailus
2023-09-15  9:48   ` Laurent Pinchart
2023-09-15  9:54     ` Sakari Ailus
2023-09-15 10:13       ` Laurent Pinchart
2023-09-15 10:27         ` Sakari Ailus
2023-09-15 11:31           ` Laurent Pinchart
2023-09-15 11:53             ` Sakari Ailus
2023-09-15 12:08               ` Laurent Pinchart
2023-09-15  7:28 ` [PATCH 7/7] media: ov2740: Return -EPROBE_DEFER if no endpoint is found Sakari Ailus
2023-09-15  9:50   ` Laurent Pinchart
2023-09-15 20:25     ` Sakari Ailus
2023-09-29 12:37     ` Sakari Ailus
2023-09-29 14:25       ` Hans de Goede

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=20230915072809.37886-2-sakari.ailus@linux.intel.com \
    --to=sakari.ailus@linux.intel.com \
    --cc=bingbu.cao@intel.com \
    --cc=jacopo+renesas@jmondi.org \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-media@vger.kernel.org \
    --cc=tian.shu.qiu@intel.com \
    --cc=tomi.valkeinen@ideasonboard.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