Message-ID: <aCqKvd4xJJVEzOar@archie.me>
Date: Mon, 19 May 2025 08:34:53 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Hanne-Lotta Mäenpää <hannelotta@...il.com>,
	mchehab@...nel.org, ribalda@...omium.org, hverkuil@...all.nl,
	hljunggr@...co.com, dave.jiang@...el.com, jgg@...pe.ca,
	saeedm@...dia.com, Jonathan.Cameron@...wei.com, corbet@....net,
	ilpo.jarvinen@...ux.intel.com, mario.limonciello@....com,
	W_Armin@....de, mpearson-lenovo@...ebb.ca
Cc: linux-media@...r.kernel.org, linux-kernel@...r.kernel.org,
	linux-kernel-mentees@...ts.linux.dev
Subject: Re: [PATCH 1/4] docs: Improve grammar in Userspace API/DVB API

On Sat, May 17, 2025 at 04:27:08PM +0300, Hanne-Lotta Mäenpää wrote:
> diff --git a/Documentation/userspace-api/media/dvb/fe-diseqc-send-burst.rst b/Documentation/userspace-api/media/dvb/fe-diseqc-send-burst.rst
> index 8fb73ee29951..6ac1e5cd50ce 100644
> --- a/Documentation/userspace-api/media/dvb/fe-diseqc-send-burst.rst
> +++ b/Documentation/userspace-api/media/dvb/fe-diseqc-send-burst.rst
> @@ -26,7 +26,7 @@ Arguments
>      File descriptor returned by :c:func:`open()`.
>  
>  ``tone``
> -    An integer enumered value described at :c:type:`fe_sec_mini_cmd`.
> +    An integer enumerated value described at :c:type:`fe_sec_mini_cmd`.
>  
>  Description
>  ===========
> diff --git a/Documentation/userspace-api/media/dvb/fe-set-tone.rst b/Documentation/userspace-api/media/dvb/fe-set-tone.rst
> index 9f44bf946183..a985eec140cf 100644
> --- a/Documentation/userspace-api/media/dvb/fe-set-tone.rst
> +++ b/Documentation/userspace-api/media/dvb/fe-set-tone.rst
> @@ -26,7 +26,7 @@ Arguments
>      File descriptor returned by :c:func:`open()`.
>  
>  ``tone``
> -    an integer enumered value described at :c:type:`fe_sec_tone_mode`
> +    An integer enumerated value described at :c:type:`fe_sec_tone_mode`
>  
>  Description
>  ===========
> @@ -41,7 +41,7 @@ this is done using the DiSEqC ioctls.
>  
>  .. attention:: If more than one device is connected to the same antenna,
>     setting a tone may interfere on other devices, as they may lose the
> -   capability of selecting the band. So, it is recommended that applications
> +   capability of selecting the band. It is recommended that applications
>     would change to SEC_TONE_OFF when the device is not used.
>  
>  Return Value
> diff --git a/Documentation/userspace-api/media/dvb/fe-set-voltage.rst b/Documentation/userspace-api/media/dvb/fe-set-voltage.rst
> index c66771830be1..e80ba7220d2d 100644
> --- a/Documentation/userspace-api/media/dvb/fe-set-voltage.rst
> +++ b/Documentation/userspace-api/media/dvb/fe-set-voltage.rst
> @@ -26,7 +26,7 @@ Arguments
>      File descriptor returned by :c:func:`open()`.
>  
>  ``voltage``
> -    an integer enumered value described at :c:type:`fe_sec_voltage`
> +    An integer enumerated value described at :c:type:`fe_sec_voltage`
>  
>  Description
>  ===========
> @@ -44,7 +44,7 @@ power up the LNBf.
>  
>  .. attention:: if more than one device is connected to the same antenna,
>     setting a voltage level may interfere on other devices, as they may lose
> -   the capability of setting polarization or IF. So, on those cases, setting
> +   the capability of setting polarization or IF. In those cases, setting
>     the voltage to SEC_VOLTAGE_OFF while the device is not is used is
>     recommended.

Either way looks fine.

>  
> diff --git a/Documentation/userspace-api/media/dvb/fe_property_parameters.rst b/Documentation/userspace-api/media/dvb/fe_property_parameters.rst
> index 1717a0565fe8..2e067fac1ce7 100644
> --- a/Documentation/userspace-api/media/dvb/fe_property_parameters.rst
> +++ b/Documentation/userspace-api/media/dvb/fe_property_parameters.rst
> @@ -72,11 +72,11 @@ DTV_MODULATION
>  ==============
>  
>  Specifies the frontend modulation type for delivery systems that
> -supports more multiple modulations.
> +support multiple modulations.
>  
>  The modulation can be one of the types defined by enum :c:type:`fe_modulation`.
>  
> -Most of the digital TV standards offers more than one possible
> +Most of the digital TV standards offer more than one possible
>  modulation type.
>  
>  The table below presents a summary of the types of modulation types
> @@ -143,9 +143,8 @@ ISDB-T			5MHz, 6MHz, 7MHz and 8MHz, although most places
>       (DTV_ISDBT_SB_SEGMENT_IDX, DTV_ISDBT_SB_SEGMENT_COUNT).
>  
>    #. On Satellite and Cable delivery systems, the bandwidth depends on
> -     the symbol rate. So, the Kernel will silently ignore any setting
> -     :ref:`DTV-BANDWIDTH-HZ`. I will however fill it back with a
> -     bandwidth estimation.
> +     the symbol rate. The kernel will silently ignore any setting
> +     :ref:`DTV-BANDWIDTH-HZ` and overwrites it with bandwidth estimation.
>  
>       Such bandwidth estimation takes into account the symbol rate set with
>       :ref:`DTV-SYMBOL-RATE`, and the rolloff factor, with is fixed for
> @@ -200,7 +199,7 @@ DTV_VOLTAGE
>  Used on satellite delivery systems.
>  
>  The voltage is usually used with non-DiSEqC capable LNBs to switch the
> -polarzation (horizontal/vertical). When using DiSEqC epuipment this
> +polarization (horizontal/vertical). When using DiSEqC equipment this
>  voltage has to be switched consistently to the DiSEqC commands as
>  described in the DiSEqC spec.
>  
> @@ -280,7 +279,7 @@ DTV_ISDBT_PARTIAL_RECEPTION
>  
>  Used only on ISDB.
>  
> -If ``DTV_ISDBT_SOUND_BROADCASTING`` is '0' this bit-field represents
> +If ``DTV_ISDBT_SOUND_BROADCASTING`` is '0' this bit field represents
>  whether the channel is in partial reception mode or not.
>  
>  If '1' ``DTV_ISDBT_LAYERA_*`` values are assigned to the center segment
> @@ -331,8 +330,8 @@ broadcaster has several possibilities to put those channels in the air:
>  Assuming a normal 13-segment ISDB-T spectrum he can align the 8 segments
>  from position 1-8 to 5-13 or anything in between.
>  
> -The underlying layer of segments are subchannels: each segment is
> -consisting of several subchannels with a predefined IDs. A sub-channel
> +The underlying layer of segments are sub-channels: each segment is
> +consisting of several sub-channels with a predefined IDs. A sub-channel
>  is used to help the demodulator to synchronize on the channel.
>  
>  An ISDB-T channel is always centered over all sub-channels. As for the
> @@ -728,7 +727,7 @@ DTV_ATSCMH_RS_FRAME_ENSEMBLE
>  
>  Used only on ATSC-MH.
>  
> -Reed Solomon(RS) frame ensemble.
> +Reed Solomon (RS) frame ensemble.
>  
>  The acceptable values are defined by :c:type:`atscmh_rs_frame_ensemble`.
>  
> @@ -954,14 +953,14 @@ DTV_ENUM_DELSYS
>  
>  A Multi standard frontend needs to advertise the delivery systems
>  provided. Applications need to enumerate the provided delivery systems,
> -before using any other operation with the frontend. Prior to it's
> +before using any other operation with the frontend. Prior to its
>  introduction, FE_GET_INFO was used to determine a frontend type. A
>  frontend which provides more than a single delivery system,
>  FE_GET_INFO doesn't help much. Applications which intends to use a
>  multistandard frontend must enumerate the delivery systems associated
>  with it, rather than trying to use FE_GET_INFO. In the case of a
>  legacy frontend, the result is just the same as with FE_GET_INFO, but
> -in a more structured format
> +in a more structured format.
>  
>  The acceptable values are defined by :c:type:`fe_delivery_system`.
>  
> diff --git a/Documentation/userspace-api/media/dvb/frontend-property-terrestrial-systems.rst b/Documentation/userspace-api/media/dvb/frontend-property-terrestrial-systems.rst
> index 8cd461ceeea7..8aad9ea817f2 100644
> --- a/Documentation/userspace-api/media/dvb/frontend-property-terrestrial-systems.rst
> +++ b/Documentation/userspace-api/media/dvb/frontend-property-terrestrial-systems.rst
> @@ -52,7 +52,7 @@ DVB-T2 delivery system
>  ======================
>  
>  DVB-T2 support is currently in the early stages of development, so
> -expect that this section maygrow and become more detailed with time.
> +expect that this section may grow and become more detailed with time.
>  
>  The following parameters are valid for DVB-T2:
>  
> diff --git a/Documentation/userspace-api/media/dvb/intro.rst b/Documentation/userspace-api/media/dvb/intro.rst
> index 6784ae79657c..854c2073e69a 100644
> --- a/Documentation/userspace-api/media/dvb/intro.rst
> +++ b/Documentation/userspace-api/media/dvb/intro.rst
> @@ -1,6 +1,6 @@
>  .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
>  
> -.. _dvb_introdution:
> +.. _dvb_introduction:
>  
>  ************
>  Introduction
> @@ -125,7 +125,7 @@ demux, CA and IP-over-DVB networking. The video and audio devices
>  control the MPEG2 decoder hardware, the frontend device the tuner and
>  the Digital TV demodulator. The demux device gives you control over the PES
>  and section filters of the hardware. If the hardware does not support
> -filtering these filters can be implemented in software. Finally, the CA
> +filtering, these filters can be implemented in software. Finally, the CA
>  device controls all the conditional access capabilities of the hardware.
>  It can depend on the individual security requirements of the platform,
>  if and how many of the CA functions are made available to the
> diff --git a/Documentation/userspace-api/media/dvb/legacy_dvb_audio.rst b/Documentation/userspace-api/media/dvb/legacy_dvb_audio.rst
> index b46fe2becd02..81b762ef17c4 100644
> --- a/Documentation/userspace-api/media/dvb/legacy_dvb_audio.rst
> +++ b/Documentation/userspace-api/media/dvb/legacy_dvb_audio.rst
> @@ -195,7 +195,7 @@ Description
>  ~~~~~~~~~~~
>  
>  The audio channel selected via `AUDIO_CHANNEL_SELECT`_ is determined by
> -this values.
> +this value.
>  
>  
>  -----
> @@ -413,7 +413,7 @@ Constants
>         -  ``AUDIO_CAP_MP3``
>  
>         -  The hardware accepts MPEG-1 Audio Layer III.
> -          Commomly known as .mp3.
> +          Commonly known as .mp3.
>  
>      -  ..
>  

The rest LGTM.

Thanks.

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

Download attachment "signature.asc" of type "application/pgp-signature" (229 bytes)

Powered by blists - more mailing lists