media: doc: Document dual use of H.264 pic_num/frame_num
authorNicolas Dufresne <nicolas.dufresne@collabora.com>
Tue, 26 Apr 2022 12:57:27 +0000 (14:57 +0200)
committerMauro Carvalho Chehab <mchehab@kernel.org>
Fri, 13 May 2022 12:58:29 +0000 (14:58 +0200)
commit804e192a81149ef43ccaf09ac65b264813ad511b
tree928d3ab69b10ac044115a9a1d094b78463d56d75
parent397edc703a10f670a2692e492a245f6be1fe279a
media: doc: Document dual use of H.264 pic_num/frame_num

These two fields need documentation as they have dual meaning. It is also
confusing since pic_num is a derived value from frame_num, so this should
help application developers. If we ever need to make a V2 of this API, I
would suggest to remove pic_num entirely.

Signed-off-by: Nicolas Dufresne <nicolas.dufresne@collabora.com>
Reviewed-by: Sebastian Fricke <sebastian.fricke@collabora.com>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst