diff mbox series

[05/13] media: ext-ctrls-codec-stateless.rst: change a FWHT flag description

Message ID f85e13b9ecf0a68457f9f88919995f130272df08.1607597287.git.mchehab+huawei@kernel.org
State Accepted
Commit f23f5c709427e2b76b7280a1361a84a67aa0162b
Headers show
Series Address issues with PDF output at media uAPI docs | expand

Commit Message

Mauro Carvalho Chehab Dec. 10, 2020, 10:55 a.m. UTC
Instead of using "- 1", use "minus one".

The reason is that, if the table is split like:

  V4L2_FWHT_FL_COMPONENTS_NUM_MSK  0x00070000  The number of color components
                                               - 1.

One might not realize the meaning of the second line.

As a side effect, using text instead of arabic numbers is
more appropriate for formal documents like this spec.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 .../userspace-api/media/v4l/ext-ctrls-codec-stateless.rst       | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst
index 01e3b1a3fb99..e1537ffc6eaa 100644
--- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst
+++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec-stateless.rst
@@ -778,7 +778,7 @@  FWHT Flags
       - Set if this is an I-frame.
     * - ``V4L2_FWHT_FL_COMPONENTS_NUM_MSK``
       - 0x00070000
-      - The number of color components - 1.
+      - The number of color components minus one.
     * - ``V4L2_FWHT_FL_PIXENC_MSK``
       - 0x00180000
       - The mask for the pixel encoding.