OSDN Git Service

media: doc/media api: Try to make enum usage clearer
authorDorota Czaplejewicz <dorota.czaplejewicz@puri.sm>
Sun, 19 Feb 2023 11:00:34 +0000 (12:00 +0100)
committerMauro Carvalho Chehab <mchehab@kernel.org>
Mon, 20 Mar 2023 14:26:15 +0000 (15:26 +0100)
commit5a26272f9c2fade261e063f0c901e72979dd30a0
tree12861b71953ff560fc433978179973cd74b26a57
parent2d41947ec2c0140c65783982692c2e3d89853c47
media: doc/media api: Try to make enum usage clearer

This clarifies which side of the calls is responsible for doing what to
which parts of the struct. This also explicitly states that repeating
values are disallowed. It also expands the terse description of the access
algorithm into more prose-like, active voice description, which trades
conciseness for ease of comprehension.

Added: mbus codes must not repeat
Added: no holes in the enumeration
Added: enumerations per what?
Added: who fills in what in calls
Changed: "zero" -> "0"
Changed: "given" -> "specified"

Still unclear how it works so didn't describe: "which". What is a "try
format" vs "active format"?

[Sakari Ailus: Rewrap lines, fix build issue]

Signed-off-by: Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>
Acked-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Documentation/userspace-api/media/v4l/vidioc-subdev-enum-mbus-code.rst