| Message ID | 20250517132711.117618-1-hannelotta@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | [1/4] docs: Improve grammar in Userspace API/DVB API | expand |
Thanks for working to improve our documentation! Hanne-Lotta Mäenpää <hannelotta@gmail.com> writes: > Fix typos, punctuation and improve grammar and formatting > in documentation for Video4Linux (V4L). > > Signed-off-by: Hanne-Lotta Mäenpää <hannelotta@gmail.com> > --- > .../userspace-api/media/v4l/biblio.rst | 8 ++--- > .../media/v4l/dev-sliced-vbi.rst | 4 +-- > .../media/v4l/ext-ctrls-fm-rx.rst | 15 ++++------ > .../media/v4l/ext-ctrls-fm-tx.rst | 29 +++++++------------ > .../media/v4l/pixfmt-srggb12p.rst | 4 +-- > .../media/v4l/pixfmt-srggb14p.rst | 2 +- > 6 files changed, 25 insertions(+), 37 deletions(-) > > diff --git a/Documentation/userspace-api/media/v4l/biblio.rst b/Documentation/userspace-api/media/v4l/biblio.rst > index 35674eeae20d..c3f7c466e287 100644 > --- a/Documentation/userspace-api/media/v4l/biblio.rst > +++ b/Documentation/userspace-api/media/v4l/biblio.rst > @@ -53,7 +53,7 @@ ISO 13818-1 > > :title: ITU-T Rec. H.222.0 | ISO/IEC 13818-1 "Information technology --- Generic coding of moving pictures and associated audio information: Systems" > > -:author: International Telecommunication Union (http://www.itu.ch), International Organisation for Standardisation (http://www.iso.ch) > +:author: International Telecommunication Union (http://www.itu.ch), International Organization for Standardization (http://www.iso.ch) Please do not "fix" the use of either British or American spellings; both are explicitly just fine for kernel docs. > .. _mpeg2part2: > > @@ -63,7 +63,7 @@ ISO 13818-2 > > :title: ITU-T Rec. H.262 | ISO/IEC 13818-2 "Information technology --- Generic coding of moving pictures and associated audio information: Video" > > -:author: International Telecommunication Union (http://www.itu.ch), International Organisation for Standardisation (http://www.iso.ch) > +:author: International Telecommunication Union (http://www.itu.ch), International Organization for Standardization (http://www.iso.ch) > > .. _itu470: > > @@ -131,7 +131,7 @@ ITU H.265/HEVC > > :title: ITU-T Rec. H.265 | ISO/IEC 23008-2 "High Efficiency Video Coding" > > -:author: International Telecommunication Union (http://www.itu.ch), International Organisation for Standardisation (http://www.iso.ch) > +:author: International Telecommunication Union (http://www.itu.ch), International Organization for Standardization (http://www.iso.ch) > > .. _jfif: > > @@ -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..565157709911 100644 > --- a/Documentation/userspace-api/media/v4l/ext-ctrls-fm-rx.rst > +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-fm-rx.rst > @@ -35,7 +35,7 @@ FM_RX Control IDs > description of the correct character encoding for Programme Service > name strings. Also from RDS specification, PS is usually a single > eight character text. However, it is also possible to find receivers > - which can scroll strings sized as 8 x N characters. So, this control > + which can scroll strings sized as 8 x N characters. Therefore this control This kind of change just seems like churn that isn't really improving the content? > must be configured with steps of 8 characters. The result is it must > always contain a string with size multiple of 8. > > @@ -49,7 +49,7 @@ FM_RX Control IDs > Radio Text strings depends on which RDS Block is being used to > transmit it, either 32 (2A block) or 64 (2B block). However, it is > also possible to find receivers which can scroll strings sized as 32 > - x N or 64 x N characters. So, this control must be configured with > + x N or 64 x N characters. Therefore this control must be configured with > steps of 32 or 64 characters. The result is it must always contain a > string with size multiple of 32 or 64. > > @@ -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..aa509039bd27 100644 > --- a/Documentation/userspace-api/media/v4l/ext-ctrls-fm-tx.rst > +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-fm-tx.rst > @@ -41,7 +41,7 @@ FM_TX Control IDs > description of the correct character encoding for Programme Service > name strings. Also from RDS specification, PS is usually a single > eight character text. However, it is also possible to find receivers > - which can scroll strings sized as 8 x N characters. So, this control > + which can scroll strings sized as 8 x N characters. Therefore this control > must be configured with steps of 8 characters. The result is it must > always contain a string with size multiple of 8. > > @@ -55,7 +55,7 @@ FM_TX Control IDs > E of :ref:`iec62106`. The length of Radio Text strings depends on > which RDS Block is being used to transmit it, either 32 (2A block) > or 64 (2B block). However, it is also possible to find receivers > - which can scroll strings sized as 32 x N or 64 x N characters. So, > + which can scroll strings sized as 32 x N or 64 x N characters. Therefore > this control must be configured with steps of 32 or 64 characters. > The result is it must always contain a string with size multiple of > 32 or 64. > @@ -94,8 +94,8 @@ FM_TX Control IDs > > ``V4L2_CID_RDS_TX_ALT_FREQS (__u32 array)`` > The alternate frequencies in kHz units. The RDS standard allows for > - up to 25 frequencies to be defined. Drivers may support fewer > - frequencies so check the array size. > + up to 25 frequencies to be defined. Because drivers may support fewer > + frequencies, check the array size. Here too, I'm not sure I see the value in this kind of change. Thanks, jon
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. 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. - ..
Fix typos and punctuation and improve grammar in documentation for Digital TV API, also known as Linux DVB API. Signed-off-by: Hanne-Lotta Mäenpää <hannelotta@gmail.com> --- .../media/dvb/fe-diseqc-send-burst.rst | 2 +- .../userspace-api/media/dvb/fe-set-tone.rst | 4 ++-- .../media/dvb/fe-set-voltage.rst | 4 ++-- .../media/dvb/fe_property_parameters.rst | 23 +++++++++---------- .../frontend-property-terrestrial-systems.rst | 2 +- .../userspace-api/media/dvb/intro.rst | 4 ++-- .../media/dvb/legacy_dvb_audio.rst | 4 ++-- 7 files changed, 21 insertions(+), 22 deletions(-)