diff mbox series

[v2,1/3] media: subdev: Use 'shall' instead of 'may' in route validation

Message ID 20230302095748.100898-2-tomi.valkeinen@ideasonboard.com (mailing list archive)
State New, archived
Headers show
Series [v2,1/3] media: subdev: Use 'shall' instead of 'may' in route validation | expand

Commit Message

Tomi Valkeinen March 2, 2023, 9:57 a.m. UTC
Route validation docs use the word 'may'. Change that to 'shall' for
emphasis.

Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
---
 drivers/media/v4l2-core/v4l2-subdev.c | 2 +-
 include/media/v4l2-subdev.h           | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

Comments

Jacopo Mondi March 2, 2023, 10:41 a.m. UTC | #1
Hi Tomi,
   thanks!

On Thu, Mar 02, 2023 at 11:57:46AM +0200, Tomi Valkeinen wrote:
> Route validation docs use the word 'may'. Change that to 'shall' for
> emphasis.
>
> Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>

Reviewed-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>

> ---
>  drivers/media/v4l2-core/v4l2-subdev.c | 2 +-
>  include/media/v4l2-subdev.h           | 6 +++---
>  2 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/media/v4l2-core/v4l2-subdev.c b/drivers/media/v4l2-core/v4l2-subdev.c
> index dff1d9be7841..8308d20f1bd1 100644
> --- a/drivers/media/v4l2-core/v4l2-subdev.c
> +++ b/drivers/media/v4l2-core/v4l2-subdev.c
> @@ -1694,7 +1694,7 @@ int v4l2_subdev_routing_validate(struct v4l2_subdev *sd,
>
>  		/*
>  		 * V4L2_SUBDEV_ROUTING_NO_STREAM_MIX: Streams on the same pad
> -		 * may not be routed to streams on different pads.
> +		 * shall not be routed to streams on different pads.
>  		 */
>  		if (disallow & V4L2_SUBDEV_ROUTING_NO_STREAM_MIX) {
>  			if (remote_pads[route->sink_pad] != U32_MAX &&
> diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
> index 17773be4a4ee..3649f11a4c35 100644
> --- a/include/media/v4l2-subdev.h
> +++ b/include/media/v4l2-subdev.h
> @@ -1638,13 +1638,13 @@ u64 v4l2_subdev_state_xlate_streams(const struct v4l2_subdev_state *state,
>   * enum v4l2_subdev_routing_restriction - Subdevice internal routing restrictions
>   *
>   * @V4L2_SUBDEV_ROUTING_NO_1_TO_N:
> - *	an input stream may not be routed to multiple output streams (stream
> + *	an input stream shall not be routed to multiple output streams (stream
>   *	duplication)
>   * @V4L2_SUBDEV_ROUTING_NO_N_TO_1:
> - *	multiple input streams may not be routed to the same output stream
> + *	multiple input streams shall not be routed to the same output stream
>   *	(stream merging)
>   * @V4L2_SUBDEV_ROUTING_NO_STREAM_MIX:
> - *	streams on the same pad may not be routed to streams on different pads
> + *	streams on the same pad shall not be routed to streams on different pads
>   * @V4L2_SUBDEV_ROUTING_ONLY_1_TO_1:
>   *	only non-overlapping 1-to-1 stream routing is allowed (a combination of
>   *	@V4L2_SUBDEV_ROUTING_NO_1_TO_N and @V4L2_SUBDEV_ROUTING_NO_N_TO_1)
> --
> 2.34.1
>
diff mbox series

Patch

diff --git a/drivers/media/v4l2-core/v4l2-subdev.c b/drivers/media/v4l2-core/v4l2-subdev.c
index dff1d9be7841..8308d20f1bd1 100644
--- a/drivers/media/v4l2-core/v4l2-subdev.c
+++ b/drivers/media/v4l2-core/v4l2-subdev.c
@@ -1694,7 +1694,7 @@  int v4l2_subdev_routing_validate(struct v4l2_subdev *sd,
 
 		/*
 		 * V4L2_SUBDEV_ROUTING_NO_STREAM_MIX: Streams on the same pad
-		 * may not be routed to streams on different pads.
+		 * shall not be routed to streams on different pads.
 		 */
 		if (disallow & V4L2_SUBDEV_ROUTING_NO_STREAM_MIX) {
 			if (remote_pads[route->sink_pad] != U32_MAX &&
diff --git a/include/media/v4l2-subdev.h b/include/media/v4l2-subdev.h
index 17773be4a4ee..3649f11a4c35 100644
--- a/include/media/v4l2-subdev.h
+++ b/include/media/v4l2-subdev.h
@@ -1638,13 +1638,13 @@  u64 v4l2_subdev_state_xlate_streams(const struct v4l2_subdev_state *state,
  * enum v4l2_subdev_routing_restriction - Subdevice internal routing restrictions
  *
  * @V4L2_SUBDEV_ROUTING_NO_1_TO_N:
- *	an input stream may not be routed to multiple output streams (stream
+ *	an input stream shall not be routed to multiple output streams (stream
  *	duplication)
  * @V4L2_SUBDEV_ROUTING_NO_N_TO_1:
- *	multiple input streams may not be routed to the same output stream
+ *	multiple input streams shall not be routed to the same output stream
  *	(stream merging)
  * @V4L2_SUBDEV_ROUTING_NO_STREAM_MIX:
- *	streams on the same pad may not be routed to streams on different pads
+ *	streams on the same pad shall not be routed to streams on different pads
  * @V4L2_SUBDEV_ROUTING_ONLY_1_TO_1:
  *	only non-overlapping 1-to-1 stream routing is allowed (a combination of
  *	@V4L2_SUBDEV_ROUTING_NO_1_TO_N and @V4L2_SUBDEV_ROUTING_NO_N_TO_1)