Re: [PATCH v2 2/4] docs: Improve grammar, formatting in Video4Linux

Bagas Sanjaya
2025-05-23T06:03:38Z

[-- Attachment #1: Type: text/plain, Size: 8370 bytes --]

On Thu, May 22, 2025 at 02:52:53PM +0300, Hanne-Lotta Mäenpää wrote:
> diff --git a/Documentation/userspace-api/media/v4l/biblio.rst b/Documentation/userspace-api/media/v4l/biblio.rst
> index 35674eeae20d..856acf6a890c 100644
> --- a/Documentation/userspace-api/media/v4l/biblio.rst
> +++ b/Documentation/userspace-api/media/v4l/biblio.rst
> @@ -150,7 +150,7 @@ ITU-T.81
> ========
>
>
> -:title: ITU-T Recommendation T.81 "Information Technology --- Digital Compression and Coding of Continous-Tone Still Images --- Requirements and Guidelines"
> +:title: ITU-T Recommendation T.81 "Information Technology --- Digital Compression and Coding of Continuous-Tone Still Images --- Requirements and Guidelines"
>
> :author: International Telecommunication Union (http://www.itu.int)
>
> diff --git a/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst b/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst
> index 42cdb0a9f786..96e0e85a822c 100644
> --- a/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst
> +++ b/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst
> @@ -48,7 +48,7 @@ capabilities, and they may support :ref:`control` ioctls.
> The :ref:`video standard <standard>` ioctls provide information vital
> to program a sliced VBI device, therefore must be supported.
>
> -.. _sliced-vbi-format-negotitation:
> +.. _sliced-vbi-format-negotiation:
>
> Sliced VBI Format Negotiation
> =============================
> @@ -377,7 +377,7 @@ Sliced VBI Data in MPEG Streams
>
> If a device can produce an MPEG output stream, it may be capable of
> providing
> -:ref:`negotiated sliced VBI services <sliced-vbi-format-negotitation>`
> +:ref:`negotiated sliced VBI services <sliced-vbi-format-negotiation>`
> as data embedded in the MPEG stream. Users or applications control this
> sliced VBI data insertion with the
> :ref:`V4L2_CID_MPEG_STREAM_VBI_FMT <v4l2-mpeg-stream-vbi-fmt>`
> diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-fm-rx.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-fm-rx.rst
> index b6cfc0e823d2..ccd439e9e0e3 100644
> --- a/Documentation/userspace-api/media/v4l/ext-ctrls-fm-rx.rst
> +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-fm-rx.rst
> @@ -64,17 +64,12 @@ FM_RX Control IDs
> broadcasts speech. If the transmitter doesn't make this distinction,
> then it will be set.
>
> -``V4L2_CID_TUNE_DEEMPHASIS``
> - (enum)
> -
> -enum v4l2_deemphasis -
> +``V4L2_CID_TUNE_DEEMPHASIS (enum)``
> Configures the de-emphasis value for reception. A de-emphasis filter
> is applied to the broadcast to accentuate the high audio
> frequencies. Depending on the region, a time constant of either 50
> - or 75 useconds is used. The enum v4l2_deemphasis defines possible
> - values for de-emphasis. Here they are:
> -
> -
> + or 75 microseconds is used. The enum v4l2_deemphasis defines possible
> + values for de-emphasis. They are:
>
> .. flat-table::
> :header-rows: 0
> diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-fm-tx.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-fm-tx.rst
> index 04c997c9a4c3..cb40cf4cc3ec 100644
> --- a/Documentation/userspace-api/media/v4l/ext-ctrls-fm-tx.rst
> +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-fm-tx.rst
> @@ -104,7 +104,7 @@ FM_TX Control IDs
>
> ``V4L2_CID_AUDIO_LIMITER_RELEASE_TIME (integer)``
> Sets the audio deviation limiter feature release time. Unit is in
> - useconds. Step and range are driver-specific.
> + microseconds. Step and range are driver-specific.
>
> ``V4L2_CID_AUDIO_LIMITER_DEVIATION (integer)``
> Configures audio frequency deviation level in Hz. The range and step
> @@ -121,16 +121,16 @@ FM_TX Control IDs
> range and step are driver-specific.
>
> ``V4L2_CID_AUDIO_COMPRESSION_THRESHOLD (integer)``
> - Sets the threshold level for audio compression freature. It is a dB
> + Sets the threshold level for audio compression feature. It is a dB
> value. The range and step are driver-specific.
>
> ``V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME (integer)``
> - Sets the attack time for audio compression feature. It is a useconds
> + Sets the attack time for audio compression feature. It is a microseconds
> value. The range and step are driver-specific.
>
> ``V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME (integer)``
> Sets the release time for audio compression feature. It is a
> - useconds value. The range and step are driver-specific.
> + microseconds value. The range and step are driver-specific.
>
> ``V4L2_CID_PILOT_TONE_ENABLED (boolean)``
> Enables or disables the pilot tone generation feature.
> @@ -143,17 +143,12 @@ FM_TX Control IDs
> Configures pilot tone frequency value. Unit is in Hz. The range and
> step are driver-specific.
>
> -``V4L2_CID_TUNE_PREEMPHASIS``
> - (enum)
> -
> -enum v4l2_preemphasis -
> +``V4L2_CID_TUNE_PREEMPHASIS (enum)``
> Configures the pre-emphasis value for broadcasting. A pre-emphasis
> filter is applied to the broadcast to accentuate the high audio
> frequencies. Depending on the region, a time constant of either 50
> - or 75 useconds is used. The enum v4l2_preemphasis defines possible
> - values for pre-emphasis. Here they are:
> -
> -
> + or 75 microseconds is used. The enum v4l2_preemphasis defines possible
> + values for pre-emphasis. They are:
>
> .. flat-table::
> :header-rows: 0
> @@ -166,8 +161,6 @@ enum v4l2_preemphasis -
> * - ``V4L2_PREEMPHASIS_75_uS``
> - A pre-emphasis of 75 uS is used.
>
> -
> -
> ``V4L2_CID_TUNE_POWER_LEVEL (integer)``
> Sets the output power level for signal transmission. Unit is in
> dBuV. Range and step are driver-specific.
> diff --git a/Documentation/userspace-api/media/v4l/pixfmt-srggb12p.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb12p.rst
> index 7c3810ff783c..8c03aedcc00e 100644
> --- a/Documentation/userspace-api/media/v4l/pixfmt-srggb12p.rst
> +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb12p.rst
> @@ -6,7 +6,7 @@
> .. _v4l2-pix-fmt-sgrbg12p:
>
> *******************************************************************************************************************************
> -V4L2_PIX_FMT_SRGGB12P ('pRCC'), V4L2_PIX_FMT_SGRBG12P ('pgCC'), V4L2_PIX_FMT_SGBRG12P ('pGCC'), V4L2_PIX_FMT_SBGGR12P ('pBCC'),
> +V4L2_PIX_FMT_SRGGB12P ('pRCC'), V4L2_PIX_FMT_SGRBG12P ('pgCC'), V4L2_PIX_FMT_SGBRG12P ('pGCC'), V4L2_PIX_FMT_SBGGR12P ('pBCC')
> *******************************************************************************************************************************
>
>
> @@ -20,7 +20,7 @@ Description
> These four pixel formats are packed raw sRGB / Bayer formats with 12
> bits per colour. Every two consecutive samples are packed into three
> bytes. Each of the first two bytes contain the 8 high order bits of
> -the pixels, and the third byte contains the four least significants
> +the pixels, and the third byte contains the four least significant
> bits of each pixel, in the same order.
>
> Each n-pixel row contains n/2 green samples and n/2 blue or red
> diff --git a/Documentation/userspace-api/media/v4l/pixfmt-srggb14p.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb14p.rst
> index 3572e42adb22..f4f53d7dbdeb 100644
> --- a/Documentation/userspace-api/media/v4l/pixfmt-srggb14p.rst
> +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb14p.rst
> @@ -24,7 +24,7 @@ These four pixel formats are packed raw sRGB / Bayer formats with 14
> bits per colour. Every four consecutive samples are packed into seven
> bytes. Each of the first four bytes contain the eight high order bits
> of the pixels, and the three following bytes contains the six least
> -significants bits of each pixel, in the same order.
> +significant bits of each pixel, in the same order.
>
> Each n-pixel row contains n/2 green samples and n/2 blue or red samples,
> with alternating green-red and green-blue rows. They are conventionally

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

--
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]