Re: [PATCH v3 01/10] media: Documentation: Align numbered list

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, Sep 06, 2023 at 12:43:44PM +0000, Sakari Ailus wrote:
> On Tue, Sep 05, 2023 at 04:06:40PM +0300, Laurent Pinchart wrote:
> > On Tue, Aug 08, 2023 at 10:55:29AM +0300, Sakari Ailus wrote:
> > > Align lines for numbered list so that Sphinx produces an uniform output
> > > for all list entries.
> > > 
> > > Signed-off-by: Sakari Ailus <sakari.ailus@xxxxxxxxxxxxxxx>
> > > ---
> > >  .../userspace-api/media/v4l/dev-subdev.rst    | 27 +++++++++----------
> > >  1 file changed, 13 insertions(+), 14 deletions(-)
> > > 
> > > diff --git a/Documentation/userspace-api/media/v4l/dev-subdev.rst b/Documentation/userspace-api/media/v4l/dev-subdev.rst
> > > index a4f1df7093e8..b023918177b5 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>`
> > 
> > While at it, could we standardize on 1. vs. 1) ? Both are used in the
> > same file. After this patch they both render to "1.", but it would be
> > nice to be consistent in the source too.
> 
> I'll check the rest of the file. The number followed by a trailing dot is a
> numbered list in ReST, we should align with that.
> 
> > 
> > >  
> > > -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
> > >  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> > > @@ -619,8 +618,8 @@ 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.
> > > +   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
> > >  
> > 
> > 3) below contains two paragraphs that are not indented.
> 
> From the documentation output this does not matter. Or was your comment
> about aligning the formatting in the source? (I prefer it as-is but no
> strong opinion about it either. Just slightly easier to edit that way. :-))

I like consistency, both in the source and the output :-)

-- 
Regards,

Laurent Pinchart



[Index of Archives]     [Linux Input]     [Video for Linux]     [Gstreamer Embedded]     [Mplayer Users]     [Linux USB Devel]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Yosemite Backpacking]

  Powered by Linux