diff mbox

[1/1] docs-rst: v4l: Fix sink compose selection target documentation

Message ID 20170707142039.15954-1-sakari.ailus@linux.intel.com (mailing list archive)
State New, archived
Headers show

Commit Message

Sakari Ailus July 7, 2017, 2:20 p.m. UTC
The rectangle which the sink compose rectangle is related to is documented
to be the source compose bounds rectangle. This is in obvious conflict with
the ground rule of the format propagation (from sink to source). The reason
behind this is that this was always supposed to be the sink compose bounds
rectangle. Fix it.

Fixes: 955f645aea04 ("[media] v4l: Add subdev selections documentation")
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 Documentation/media/uapi/v4l/dev-subdev.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Hans Verkuil July 7, 2017, 2:27 p.m. UTC | #1
On 07/07/17 16:20, Sakari Ailus wrote:
> The rectangle which the sink compose rectangle is related to is documented
> to be the source compose bounds rectangle. This is in obvious conflict with
> the ground rule of the format propagation (from sink to source). The reason
> behind this is that this was always supposed to be the sink compose bounds
> rectangle. Fix it.
> 
> Fixes: 955f645aea04 ("[media] v4l: Add subdev selections documentation")
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>

Acked-by: Hans Verkuil <hans.verkuil@cisco.com>

Sooo much clearer now. It was terminally confusing...

Thanks,

	Hans

> ---
>  Documentation/media/uapi/v4l/dev-subdev.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/media/uapi/v4l/dev-subdev.rst b/Documentation/media/uapi/v4l/dev-subdev.rst
> index f0e762167730..2205a3abb2a9 100644
> --- a/Documentation/media/uapi/v4l/dev-subdev.rst
> +++ b/Documentation/media/uapi/v4l/dev-subdev.rst
> @@ -370,7 +370,7 @@ circumstances. This may also cause the accessed rectangle to be adjusted
>  by the driver, depending on the properties of the underlying hardware.
>  
>  The coordinates to a step always refer to the actual size of the
> -previous step. The exception to this rule is the source compose
> +previous step. The exception to this rule is the sink compose
>  rectangle, which refers to the sink compose bounds rectangle --- if it
>  is supported by the hardware.
>  
>
diff mbox

Patch

diff --git a/Documentation/media/uapi/v4l/dev-subdev.rst b/Documentation/media/uapi/v4l/dev-subdev.rst
index f0e762167730..2205a3abb2a9 100644
--- a/Documentation/media/uapi/v4l/dev-subdev.rst
+++ b/Documentation/media/uapi/v4l/dev-subdev.rst
@@ -370,7 +370,7 @@  circumstances. This may also cause the accessed rectangle to be adjusted
 by the driver, depending on the properties of the underlying hardware.
 
 The coordinates to a step always refer to the actual size of the
-previous step. The exception to this rule is the source compose
+previous step. The exception to this rule is the sink compose
 rectangle, which refers to the sink compose bounds rectangle --- if it
 is supported by the hardware.