Commit 1073f441 authored by Paul Kocialkowski's avatar Paul Kocialkowski Committed by Mauro Carvalho Chehab
Browse files

media: doc: codec: Rename "Return fields" to "Returned fields" for consistency 



The parts about fields that are returned typically comes after
"Required fields" so it feels more consistent to name them
"Returned fields".

Signed-off-by: default avatarPaul Kocialkowski <paul.kocialkowski@bootlin.com>
Signed-off-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
parent 1526ae0f

Documentation/userspace-api/media/v4l/dev-decoder.rst

+8 −8
Original line number Diff line number Diff line
@@ -277,7 +277,7 @@ Initialization 
     other fields

         follow standard semantics.



   * **Return fields:**

   * **Returned fields:**



     ``sizeimage``

         adjusted size of ``OUTPUT`` buffers.
@@ -311,7 +311,7 @@ Initialization 
      ``memory``

          follows standard semantics.



    * **Return fields:**

    * **Returned fields:**



      ``count``

          the actual number of buffers allocated.
@@ -339,7 +339,7 @@ Initialization 
      ``format``

          follows standard semantics.



    * **Return fields:**

    * **Returned fields:**



      ``count``

          adjusted to the number of allocated buffers.
@@ -410,7 +410,7 @@ Capture Setup 
      ``type``

          a ``V4L2_BUF_TYPE_*`` enum appropriate for ``CAPTURE``.



    * **Return fields:**

    * **Returned fields:**



      ``width``, ``height``

          frame buffer resolution for the decoded frames.
@@ -443,7 +443,7 @@ Capture Setup 
      ``target``

          set to ``V4L2_SEL_TGT_COMPOSE``.



    * **Return fields:**

    * **Returned fields:**



      ``r.left``, ``r.top``, ``r.width``, ``r.height``

          the visible rectangle; it must fit within the frame buffer resolution
@@ -552,7 +552,7 @@ Capture Setup 
         frame is written; defaults to ``V4L2_SEL_TGT_COMPOSE_DEFAULT``;

         read-only on hardware without additional compose/scaling capabilities.



   * **Return fields:**

   * **Returned fields:**



     ``r.left``, ``r.top``, ``r.width``, ``r.height``

         the visible rectangle; it must fit within the frame buffer resolution
@@ -629,7 +629,7 @@ Capture Setup 
      ``memory``

          follows standard semantics.



    * **Return fields:**

    * **Returned fields:**



      ``count``

          actual number of buffers allocated.
@@ -668,7 +668,7 @@ Capture Setup 
          a format representing the maximum framebuffer resolution to be

          accommodated by newly allocated buffers.



    * **Return fields:**

    * **Returned fields:**



      ``count``

          adjusted to the number of allocated buffers.

Documentation/userspace-api/media/v4l/dev-encoder.rst

+8 −8
Original line number Diff line number Diff line
@@ -163,7 +163,7 @@ Initialization 
     other fields

         follow standard semantics.



   * **Return fields:**

   * **Returned fields:**



     ``sizeimage``

         adjusted size of ``CAPTURE`` buffers.
@@ -189,7 +189,7 @@ Initialization 
     other fields

         follow standard semantics.



   * **Return fields:**

   * **Returned fields:**



     ``pixelformat``

         raw format supported for the coded format currently selected on
@@ -215,7 +215,7 @@ Initialization 
     other fields

         follow standard semantics.



   * **Return fields:**

   * **Returned fields:**



     ``width``, ``height``

         may be adjusted to match encoder minimums, maximums and alignment
@@ -245,7 +245,7 @@ Initialization 
	 the desired frame interval; the encoder may adjust it to

	 match hardware requirements.



   * **Return fields:**

   * **Returned fields:**



     ``parm.output.timeperframe``

	 the adjusted frame interval.
@@ -296,7 +296,7 @@ Initialization 
	 the desired coded frame interval; the encoder may adjust it to

	 match hardware requirements.



   * **Return fields:**

   * **Returned fields:**



     ``parm.capture.timeperframe``

	 the adjusted frame interval.
@@ -339,7 +339,7 @@ Initialization 
         rectangle and may be subject to adjustment to match codec and

         hardware constraints.



   * **Return fields:**

   * **Returned fields:**



     ``r.left``, ``r.top``, ``r.width``, ``r.height``

         visible rectangle adjusted by the encoder.
@@ -387,7 +387,7 @@ Initialization 
     other fields

         follow standard semantics.



   * **Return fields:**

   * **Returned fields:**



     ``count``

          actual number of buffers allocated.
@@ -420,7 +420,7 @@ Initialization 
     other fields

         follow standard semantics.



   * **Return fields:**

   * **Returned fields:**



     ``count``

         adjusted to the number of allocated buffers.

Documentation/userspace-api/media/v4l/dev-stateless-decoder.rst

+2 −2
Original line number Diff line number Diff line
@@ -180,7 +180,7 @@ Initialization 
      ``memory``

          follows standard semantics.



    * **Return fields:**

    * **Returned fields:**



      ``count``

          actual number of buffers allocated.
@@ -208,7 +208,7 @@ Initialization 
          follows standard semantics. ``V4L2_MEMORY_USERPTR`` is not supported

          for ``CAPTURE`` buffers.



    * **Return fields:**

    * **Returned fields:**



      ``count``

          adjusted to allocated number of buffers, in case the codec requires