[PATCH v2 1/4] docs: Improve grammar in Userspace API/DVB API

[PATCH v2 1/4] docs: Improve grammar in Userspace API/DVB API

[Hanne-Lotta Mäenpää]

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>
---

Notes:
    v1 -> v2:
    
    Left out changes based on feedback from Jonathan Corbet
    <corbet@lwn.net> and Bagas Sanjaya <bagasdotme@gmail.com>

 .../media/dvb/fe-diseqc-send-burst.rst        |  2 +-
 .../userspace-api/media/dvb/fe-set-tone.rst   |  2 +-
 .../media/dvb/fe-set-voltage.rst              |  2 +-
 .../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, 19 insertions(+), 20 deletions(-)

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..41cd7111a243 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
 ===========
diff --git a/Documentation/userspace-api/media/dvb/fe-set-voltage.rst b/Documentation/userspace-api/media/dvb/fe-set-voltage.rst
index c66771830be1..4d09ca5876f0 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
 ===========
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.
 
     -  ..
 
-- 
2.39.5

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

[Hanne-Lotta Mäenpää]

Fix typos, punctuation and improve grammar and formatting
in documentation for Video4Linux (V4L).

Signed-off-by: Hanne-Lotta Mäenpää <hannelotta@gmail.com>
---

Notes:
    v1 -> v2:
    
    Left out changes based on feedback from Jonathan Corbet
    <corbet@lwn.net> and Bagas Sanjaya <bagasdotme@gmail.com>

 .../userspace-api/media/v4l/biblio.rst        |  2 +-
 .../media/v4l/dev-sliced-vbi.rst              |  4 ++--
 .../media/v4l/ext-ctrls-fm-rx.rst             | 11 +++-------
 .../media/v4l/ext-ctrls-fm-tx.rst             | 21 +++++++------------
 .../media/v4l/pixfmt-srggb12p.rst             |  4 ++--
 .../media/v4l/pixfmt-srggb14p.rst             |  2 +-
 6 files changed, 16 insertions(+), 28 deletions(-)

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
-- 
2.39.5

[PATCH v2 3/4] docs: Improve grammar in Userspace API/fwctl

[Hanne-Lotta Mäenpää]

Fix typos and improve grammar in the documentation for
fwctl subsystem.

Use the word user space consistently, instead of having
two variants (user space vs. userspace).

Change wording of denied behaviour to be disallowed
behaviour when describing the interface.

Signed-off-by: Hanne-Lotta Mäenpää <hannelotta@gmail.com>
---

Notes:
    v1 -> v2: No changes

 Documentation/userspace-api/fwctl/fwctl.rst | 30 ++++++++++-----------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/Documentation/userspace-api/fwctl/fwctl.rst b/Documentation/userspace-api/fwctl/fwctl.rst
index fdcfe418a83f..a74eab8d14c6 100644
--- a/Documentation/userspace-api/fwctl/fwctl.rst
+++ b/Documentation/userspace-api/fwctl/fwctl.rst
@@ -54,7 +54,7 @@ operated by the block layer but also comes with a set of RPCs to administer the
 construction of drives within the HW RAID.
 
 In the past when devices were more single function, individual subsystems would
-grow different approaches to solving some of these common problems. For instance
+grow different approaches to solving some of these common problems. For instance,
 monitoring device health, manipulating its FLASH, debugging the FW,
 provisioning, all have various unique interfaces across the kernel.
 
@@ -87,7 +87,7 @@ device today may broadly have several function-level scopes:
  3. Multiple VM functions tightly scoped within the VM
 
 The device may create a logical parent/child relationship between these scopes.
-For instance a child VM's FW may be within the scope of the hypervisor FW. It is
+For instance, a child VM's FW may be within the scope of the hypervisor FW. It is
 quite common in the VFIO world that the hypervisor environment has a complex
 provisioning/profiling/configuration responsibility for the function VFIO
 assigns to the VM.
@@ -105,19 +105,19 @@ some general scopes of action (see enum fwctl_rpc_scope):
 
  3. Write access to function & child debug information strictly compatible with
     the principles of kernel lockdown and kernel integrity protection. Triggers
-    a kernel Taint.
+    a kernel taint.
 
- 4. Full debug device access. Triggers a kernel Taint, requires CAP_SYS_RAWIO.
+ 4. Full debug device access. Triggers a kernel taint, requires CAP_SYS_RAWIO.
 
 User space will provide a scope label on each RPC and the kernel must enforce the
 above CAPs and taints based on that scope. A combination of kernel and FW can
 enforce that RPCs are placed in the correct scope by user space.
 
-Denied behavior
----------------
+Disallowed behavior
+-------------------
 
 There are many things this interface must not allow user space to do (without a
-Taint or CAP), broadly derived from the principles of kernel lockdown. Some
+taint or CAP), broadly derived from the principles of kernel lockdown. Some
 examples:
 
  1. DMA to/from arbitrary memory, hang the system, compromise FW integrity with
@@ -138,8 +138,8 @@ examples:
 fwctl is not a replacement for device direct access subsystems like uacce or
 VFIO.
 
-Operations exposed through fwctl's non-taining interfaces should be fully
-sharable with other users of the device. For instance exposing a RPC through
+Operations exposed through fwctl's non-tainting interfaces should be fully
+sharable with other users of the device. For instance, exposing a RPC through
 fwctl should never prevent a kernel subsystem from also concurrently using that
 same RPC or hardware unit down the road. In such cases fwctl will be less
 important than proper kernel subsystems that eventually emerge. Mistakes in this
@@ -225,12 +225,12 @@ subsystems.
 
 Each device type must be mindful of Linux's philosophy for stable ABI. The FW
 RPC interface does not have to meet a strictly stable ABI, but it does need to
-meet an expectation that userspace tools that are deployed and in significant
+meet an expectation that user space tools that are deployed and in significant
 use don't needlessly break. FW upgrade and kernel upgrade should keep widely
 deployed tooling working.
 
 Development and debugging focused RPCs under more permissive scopes can have
-less stabilitiy if the tools using them are only run under exceptional
+less stability if the tools using them are only run under exceptional
 circumstances and not for every day use of the device. Debugging tools may even
 require exact version matching as they may require something similar to DWARF
 debug information from the FW binary.
@@ -261,7 +261,7 @@ Some examples:
  - HW RAID controllers. This includes RPCs to do things like compose drives into
    a RAID volume, configure RAID parameters, monitor the HW and more.
 
- - Baseboard managers. RPCs for configuring settings in the device and more
+ - Baseboard managers. RPCs for configuring settings in the device and more.
 
  - NVMe vendor command capsules. nvme-cli provides access to some monitoring
    functions that different products have defined, but more exist.
@@ -269,15 +269,15 @@ Some examples:
  - CXL also has a NVMe-like vendor command system.
 
  - DRM allows user space drivers to send commands to the device via kernel
-   mediation
+   mediation.
 
  - RDMA allows user space drivers to directly push commands to the device
-   without kernel involvement
+   without kernel involvement.
 
  - Various “raw” APIs, raw HID (SDL2), raw USB, NVMe Generic Interface, etc.
 
 The first 4 are examples of areas that fwctl intends to cover. The latter three
-are examples of denied behavior as they fully overlap with the primary purpose
+are examples of disallowed behavior as they fully overlap with the primary purpose
 of a kernel subsystem.
 
 Some key lessons learned from these past efforts are the importance of having a
-- 
2.39.5

[PATCH v2 4/4] docs: Fix typos, improve grammar in Userspace API

[Hanne-Lotta Mäenpää]

Fix a typo and improve wording and punctuation in
the documentation for Userspace API.

Signed-off-by: Hanne-Lotta Mäenpää <hannelotta@gmail.com>
---

Notes:
    v1 -> v2: No changes

 Documentation/userspace-api/sysfs-platform_profile.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/userspace-api/sysfs-platform_profile.rst b/Documentation/userspace-api/sysfs-platform_profile.rst
index 7f013356118a..6613e188242a 100644
--- a/Documentation/userspace-api/sysfs-platform_profile.rst
+++ b/Documentation/userspace-api/sysfs-platform_profile.rst
@@ -18,9 +18,9 @@ API for selecting the platform profile of these automatic mechanisms.
 Note that this API is only for selecting the platform profile, it is
 NOT a goal of this API to allow monitoring the resulting performance
 characteristics. Monitoring performance is best done with device/vendor
-specific tools such as e.g. turbostat.
+specific tools, e.g. turbostat.
 
-Specifically when selecting a high performance profile the actual achieved
+Specifically, when selecting a high performance profile the actual achieved
 performance may be limited by various factors such as: the heat generated
 by other components, room temperature, free air flow at the bottom of a
 laptop, etc. It is explicitly NOT a goal of this API to let userspace know
@@ -44,7 +44,7 @@ added. Drivers which wish to introduce new profile names must:
 "Custom" profile support
 ========================
 The platform_profile class also supports profiles advertising a "custom"
-profile. This is intended to be set by drivers when the setttings in the
+profile. This is intended to be set by drivers when the settings in the
 driver have been modified in a way that a standard profile doesn't represent
 the current state.
 
-- 
2.39.5

Re: [PATCH v2 4/4] docs: Fix typos, improve grammar in Userspace API

[Mark Pearson]

On Thu, May 22, 2025, at 7:52 AM, Hanne-Lotta Mäenpää wrote:
> Fix a typo and improve wording and punctuation in
> the documentation for Userspace API.
>
> Signed-off-by: Hanne-Lotta Mäenpää <hannelotta@gmail.com>
> ---
>
> Notes:
>     v1 -> v2: No changes
>
>  Documentation/userspace-api/sysfs-platform_profile.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/userspace-api/sysfs-platform_profile.rst 
> b/Documentation/userspace-api/sysfs-platform_profile.rst
> index 7f013356118a..6613e188242a 100644
> --- a/Documentation/userspace-api/sysfs-platform_profile.rst
> +++ b/Documentation/userspace-api/sysfs-platform_profile.rst
> @@ -18,9 +18,9 @@ API for selecting the platform profile of these 
> automatic mechanisms.
>  Note that this API is only for selecting the platform profile, it is
>  NOT a goal of this API to allow monitoring the resulting performance
>  characteristics. Monitoring performance is best done with device/vendor
> -specific tools such as e.g. turbostat.
> +specific tools, e.g. turbostat.
> 
> -Specifically when selecting a high performance profile the actual achieved
> +Specifically, when selecting a high performance profile the actual achieved
>  performance may be limited by various factors such as: the heat generated
>  by other components, room temperature, free air flow at the bottom of a
>  laptop, etc. It is explicitly NOT a goal of this API to let userspace know
> @@ -44,7 +44,7 @@ added. Drivers which wish to introduce new profile names must:
>  "Custom" profile support
>  ========================
>  The platform_profile class also supports profiles advertising a "custom"
> -profile. This is intended to be set by drivers when the setttings in the
> +profile. This is intended to be set by drivers when the settings in the
>  driver have been modified in a way that a standard profile doesn't represent
>  the current state.
> 
> -- 
> 2.39.5
Looks good to me.
Reviewed-by: Mark Pearson <mpearson-lenovo@squebb.ca>

Re: [PATCH v2 3/4] docs: Improve grammar in Userspace API/fwctl

[Dave Jiang]

On 5/22/25 4:52 AM, Hanne-Lotta Mäenpää wrote:
> Fix typos and improve grammar in the documentation for
> fwctl subsystem.
> 
> Use the word user space consistently, instead of having
> two variants (user space vs. userspace).
> 
> Change wording of denied behaviour to be disallowed
> behaviour when describing the interface.
> 
> Signed-off-by: Hanne-Lotta Mäenpää <hannelotta@gmail.com>
Reviewed-by: Dave Jiang <dave.jiang@intel.com>

> ---
> 
> Notes:
>     v1 -> v2: No changes
> 
>  Documentation/userspace-api/fwctl/fwctl.rst | 30 ++++++++++-----------
>  1 file changed, 15 insertions(+), 15 deletions(-)
> 
> diff --git a/Documentation/userspace-api/fwctl/fwctl.rst b/Documentation/userspace-api/fwctl/fwctl.rst
> index fdcfe418a83f..a74eab8d14c6 100644
> --- a/Documentation/userspace-api/fwctl/fwctl.rst
> +++ b/Documentation/userspace-api/fwctl/fwctl.rst
> @@ -54,7 +54,7 @@ operated by the block layer but also comes with a set of RPCs to administer the
>  construction of drives within the HW RAID.
>  
>  In the past when devices were more single function, individual subsystems would
> -grow different approaches to solving some of these common problems. For instance
> +grow different approaches to solving some of these common problems. For instance,
>  monitoring device health, manipulating its FLASH, debugging the FW,
>  provisioning, all have various unique interfaces across the kernel.
>  
> @@ -87,7 +87,7 @@ device today may broadly have several function-level scopes:
>   3. Multiple VM functions tightly scoped within the VM
>  
>  The device may create a logical parent/child relationship between these scopes.
> -For instance a child VM's FW may be within the scope of the hypervisor FW. It is
> +For instance, a child VM's FW may be within the scope of the hypervisor FW. It is
>  quite common in the VFIO world that the hypervisor environment has a complex
>  provisioning/profiling/configuration responsibility for the function VFIO
>  assigns to the VM.
> @@ -105,19 +105,19 @@ some general scopes of action (see enum fwctl_rpc_scope):
>  
>   3. Write access to function & child debug information strictly compatible with
>      the principles of kernel lockdown and kernel integrity protection. Triggers
> -    a kernel Taint.
> +    a kernel taint.
>  
> - 4. Full debug device access. Triggers a kernel Taint, requires CAP_SYS_RAWIO.
> + 4. Full debug device access. Triggers a kernel taint, requires CAP_SYS_RAWIO.
>  
>  User space will provide a scope label on each RPC and the kernel must enforce the
>  above CAPs and taints based on that scope. A combination of kernel and FW can
>  enforce that RPCs are placed in the correct scope by user space.
>  
> -Denied behavior
> ----------------
> +Disallowed behavior
> +-------------------
>  
>  There are many things this interface must not allow user space to do (without a
> -Taint or CAP), broadly derived from the principles of kernel lockdown. Some
> +taint or CAP), broadly derived from the principles of kernel lockdown. Some
>  examples:
>  
>   1. DMA to/from arbitrary memory, hang the system, compromise FW integrity with
> @@ -138,8 +138,8 @@ examples:
>  fwctl is not a replacement for device direct access subsystems like uacce or
>  VFIO.
>  
> -Operations exposed through fwctl's non-taining interfaces should be fully
> -sharable with other users of the device. For instance exposing a RPC through
> +Operations exposed through fwctl's non-tainting interfaces should be fully
> +sharable with other users of the device. For instance, exposing a RPC through
>  fwctl should never prevent a kernel subsystem from also concurrently using that
>  same RPC or hardware unit down the road. In such cases fwctl will be less
>  important than proper kernel subsystems that eventually emerge. Mistakes in this
> @@ -225,12 +225,12 @@ subsystems.
>  
>  Each device type must be mindful of Linux's philosophy for stable ABI. The FW
>  RPC interface does not have to meet a strictly stable ABI, but it does need to
> -meet an expectation that userspace tools that are deployed and in significant
> +meet an expectation that user space tools that are deployed and in significant
>  use don't needlessly break. FW upgrade and kernel upgrade should keep widely
>  deployed tooling working.
>  
>  Development and debugging focused RPCs under more permissive scopes can have
> -less stabilitiy if the tools using them are only run under exceptional
> +less stability if the tools using them are only run under exceptional
>  circumstances and not for every day use of the device. Debugging tools may even
>  require exact version matching as they may require something similar to DWARF
>  debug information from the FW binary.
> @@ -261,7 +261,7 @@ Some examples:
>   - HW RAID controllers. This includes RPCs to do things like compose drives into
>     a RAID volume, configure RAID parameters, monitor the HW and more.
>  
> - - Baseboard managers. RPCs for configuring settings in the device and more
> + - Baseboard managers. RPCs for configuring settings in the device and more.
>  
>   - NVMe vendor command capsules. nvme-cli provides access to some monitoring
>     functions that different products have defined, but more exist.
> @@ -269,15 +269,15 @@ Some examples:
>   - CXL also has a NVMe-like vendor command system.
>  
>   - DRM allows user space drivers to send commands to the device via kernel
> -   mediation
> +   mediation.
>  
>   - RDMA allows user space drivers to directly push commands to the device
> -   without kernel involvement
> +   without kernel involvement.
>  
>   - Various “raw” APIs, raw HID (SDL2), raw USB, NVMe Generic Interface, etc.
>  
>  The first 4 are examples of areas that fwctl intends to cover. The latter three
> -are examples of denied behavior as they fully overlap with the primary purpose
> +are examples of disallowed behavior as they fully overlap with the primary purpose
>  of a kernel subsystem.
>  
>  Some key lessons learned from these past efforts are the importance of having a

Re: [PATCH v2 1/4] docs: Improve grammar in Userspace API/DVB API

[Bagas Sanjaya]

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

On Thu, May 22, 2025 at 02:52:52PM +0300, Hanne-Lotta Mäenpää wrote:
>    #. 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.
"The kernel will silently ignore any :ref:`DTV-BANDWIDTH-HZ` setting ..."
>  
>       Such bandwidth estimation takes into account the symbol rate set with
>       :ref:`DTV-SYMBOL-RATE`, and the rolloff factor, with is fixed for

Thanks.

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

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

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

[Bagas Sanjaya]

[-- 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 --]

Re: [PATCH v2 3/4] docs: Improve grammar in Userspace API/fwctl

[Bagas Sanjaya]

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

On Thu, May 22, 2025 at 02:52:54PM +0300, Hanne-Lotta Mäenpää wrote:
> diff --git a/Documentation/userspace-api/fwctl/fwctl.rst b/Documentation/userspace-api/fwctl/fwctl.rst
> index fdcfe418a83f..a74eab8d14c6 100644
> --- a/Documentation/userspace-api/fwctl/fwctl.rst
> +++ b/Documentation/userspace-api/fwctl/fwctl.rst
> @@ -54,7 +54,7 @@ operated by the block layer but also comes with a set of RPCs to administer the
>  construction of drives within the HW RAID.
>  
>  In the past when devices were more single function, individual subsystems would
> -grow different approaches to solving some of these common problems. For instance
> +grow different approaches to solving some of these common problems. For instance,
>  monitoring device health, manipulating its FLASH, debugging the FW,
>  provisioning, all have various unique interfaces across the kernel.
>  
> @@ -87,7 +87,7 @@ device today may broadly have several function-level scopes:
>   3. Multiple VM functions tightly scoped within the VM
>  
>  The device may create a logical parent/child relationship between these scopes.
> -For instance a child VM's FW may be within the scope of the hypervisor FW. It is
> +For instance, a child VM's FW may be within the scope of the hypervisor FW. It is
>  quite common in the VFIO world that the hypervisor environment has a complex
>  provisioning/profiling/configuration responsibility for the function VFIO
>  assigns to the VM.
> @@ -105,19 +105,19 @@ some general scopes of action (see enum fwctl_rpc_scope):
>  
>   3. Write access to function & child debug information strictly compatible with
>      the principles of kernel lockdown and kernel integrity protection. Triggers
> -    a kernel Taint.
> +    a kernel taint.
>  
> - 4. Full debug device access. Triggers a kernel Taint, requires CAP_SYS_RAWIO.
> + 4. Full debug device access. Triggers a kernel taint, requires CAP_SYS_RAWIO.
>  
>  User space will provide a scope label on each RPC and the kernel must enforce the
>  above CAPs and taints based on that scope. A combination of kernel and FW can
>  enforce that RPCs are placed in the correct scope by user space.
>  
> -Denied behavior
> ----------------
> +Disallowed behavior
> +-------------------
>  
>  There are many things this interface must not allow user space to do (without a
> -Taint or CAP), broadly derived from the principles of kernel lockdown. Some
> +taint or CAP), broadly derived from the principles of kernel lockdown. Some
>  examples:
>  
>   1. DMA to/from arbitrary memory, hang the system, compromise FW integrity with
> @@ -138,8 +138,8 @@ examples:
>  fwctl is not a replacement for device direct access subsystems like uacce or
>  VFIO.
>  
> -Operations exposed through fwctl's non-taining interfaces should be fully
> -sharable with other users of the device. For instance exposing a RPC through
> +Operations exposed through fwctl's non-tainting interfaces should be fully
> +sharable with other users of the device. For instance, exposing a RPC through
>  fwctl should never prevent a kernel subsystem from also concurrently using that
>  same RPC or hardware unit down the road. In such cases fwctl will be less
>  important than proper kernel subsystems that eventually emerge. Mistakes in this
> @@ -225,12 +225,12 @@ subsystems.
>  
>  Each device type must be mindful of Linux's philosophy for stable ABI. The FW
>  RPC interface does not have to meet a strictly stable ABI, but it does need to
> -meet an expectation that userspace tools that are deployed and in significant
> +meet an expectation that user space tools that are deployed and in significant
>  use don't needlessly break. FW upgrade and kernel upgrade should keep widely
>  deployed tooling working.
>  
>  Development and debugging focused RPCs under more permissive scopes can have
> -less stabilitiy if the tools using them are only run under exceptional
> +less stability if the tools using them are only run under exceptional
>  circumstances and not for every day use of the device. Debugging tools may even
>  require exact version matching as they may require something similar to DWARF
>  debug information from the FW binary.
> @@ -261,7 +261,7 @@ Some examples:
>   - HW RAID controllers. This includes RPCs to do things like compose drives into
>     a RAID volume, configure RAID parameters, monitor the HW and more.
>  
> - - Baseboard managers. RPCs for configuring settings in the device and more
> + - Baseboard managers. RPCs for configuring settings in the device and more.
>  
>   - NVMe vendor command capsules. nvme-cli provides access to some monitoring
>     functions that different products have defined, but more exist.
> @@ -269,15 +269,15 @@ Some examples:
>   - CXL also has a NVMe-like vendor command system.
>  
>   - DRM allows user space drivers to send commands to the device via kernel
> -   mediation
> +   mediation.
>  
>   - RDMA allows user space drivers to directly push commands to the device
> -   without kernel involvement
> +   without kernel involvement.
>  
>   - Various “raw” APIs, raw HID (SDL2), raw USB, NVMe Generic Interface, etc.
>  
>  The first 4 are examples of areas that fwctl intends to cover. The latter three
> -are examples of denied behavior as they fully overlap with the primary purpose
> +are examples of disallowed behavior as they fully overlap with the primary purpose
>  of a kernel subsystem.
>  
>  Some key lessons learned from these past efforts are the importance of having a

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 --]

Re: [PATCH v2 4/4] docs: Fix typos, improve grammar in Userspace API

[Bagas Sanjaya]

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

On Thu, May 22, 2025 at 02:52:55PM +0300, Hanne-Lotta Mäenpää wrote:
> diff --git a/Documentation/userspace-api/sysfs-platform_profile.rst b/Documentation/userspace-api/sysfs-platform_profile.rst
> index 7f013356118a..6613e188242a 100644
> --- a/Documentation/userspace-api/sysfs-platform_profile.rst
> +++ b/Documentation/userspace-api/sysfs-platform_profile.rst
> @@ -18,9 +18,9 @@ API for selecting the platform profile of these automatic mechanisms.
>  Note that this API is only for selecting the platform profile, it is
>  NOT a goal of this API to allow monitoring the resulting performance
>  characteristics. Monitoring performance is best done with device/vendor
> -specific tools such as e.g. turbostat.
> +specific tools, e.g. turbostat.
>  
> -Specifically when selecting a high performance profile the actual achieved
> +Specifically, when selecting a high performance profile the actual achieved
>  performance may be limited by various factors such as: the heat generated
>  by other components, room temperature, free air flow at the bottom of a
>  laptop, etc. It is explicitly NOT a goal of this API to let userspace know
> @@ -44,7 +44,7 @@ added. Drivers which wish to introduce new profile names must:
>  "Custom" profile support
>  ========================
>  The platform_profile class also supports profiles advertising a "custom"
> -profile. This is intended to be set by drivers when the setttings in the
> +profile. This is intended to be set by drivers when the settings in the
>  driver have been modified in a way that a standard profile doesn't represent
>  the current state.
>  

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 --]

Re: [PATCH v2 3/4] docs: Improve grammar in Userspace API/fwctl

[Jonathan Corbet]

Hanne-Lotta Mäenpää <hannelotta@gmail.com> writes:

> Fix typos and improve grammar in the documentation for
> fwctl subsystem.
>
> Use the word user space consistently, instead of having
> two variants (user space vs. userspace).
>
> Change wording of denied behaviour to be disallowed
> behaviour when describing the interface.
>
> Signed-off-by: Hanne-Lotta Mäenpää <hannelotta@gmail.com>
> ---
>
> Notes:
>     v1 -> v2: No changes
>
>  Documentation/userspace-api/fwctl/fwctl.rst | 30 ++++++++++-----------
>  1 file changed, 15 insertions(+), 15 deletions(-)

I've applied this one.

Thanks,

jon

Re: [PATCH v2 4/4] docs: Fix typos, improve grammar in Userspace API

[Jonathan Corbet]

Hanne-Lotta Mäenpää <hannelotta@gmail.com> writes:

> Fix a typo and improve wording and punctuation in
> the documentation for Userspace API.
>
> Signed-off-by: Hanne-Lotta Mäenpää <hannelotta@gmail.com>
> ---
>
> Notes:
>     v1 -> v2: No changes
>
>  Documentation/userspace-api/sysfs-platform_profile.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)

Applied, thanks.

jon

Re: [PATCH v2 3/4] docs: Improve grammar in Userspace API/fwctl

[Hanne-Lotta Mäenpää]

On 6/10/25 00:12, Jonathan Corbet wrote:
> Hanne-Lotta Mäenpää <hannelotta@gmail.com> writes:
> 
>> Fix typos and improve grammar in the documentation for
>> fwctl subsystem.
>>
>> Use the word user space consistently, instead of having
>> two variants (user space vs. userspace).
>>
>> Change wording of denied behaviour to be disallowed
>> behaviour when describing the interface.
>>
>> Signed-off-by: Hanne-Lotta Mäenpää <hannelotta@gmail.com>
>> ---
>>
>> Notes:
>>      v1 -> v2: No changes
>>
>>   Documentation/userspace-api/fwctl/fwctl.rst | 30 ++++++++++-----------
>>   1 file changed, 15 insertions(+), 15 deletions(-)
> 
> I've applied this one.
> 
> Thanks,
> 
> jon

Great, thank you!

Best regards,

Hanne-Lotta Mäenpää

Re: [PATCH v2 4/4] docs: Fix typos, improve grammar in Userspace API

[Hanne-Lotta Mäenpää]

On 6/10/25 00:13, Jonathan Corbet wrote:
> Hanne-Lotta Mäenpää <hannelotta@gmail.com> writes:
> 
>> Fix a typo and improve wording and punctuation in
>> the documentation for Userspace API.
>>
>> Signed-off-by: Hanne-Lotta Mäenpää <hannelotta@gmail.com>
>> ---
>>
>> Notes:
>>      v1 -> v2: No changes
>>
>>   Documentation/userspace-api/sysfs-platform_profile.rst | 6 +++---
>>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> Applied, thanks.
> 
> jon

Thank you!

Best regards,

Hanne-Lotta Mäenpää

Re: [PATCH v2 1/4] docs: Improve grammar in Userspace API/DVB API

[Hanne-Lotta Mäenpää]

On 5/23/25 08:58, Bagas Sanjaya wrote:
> On Thu, May 22, 2025 at 02:52:52PM +0300, Hanne-Lotta Mäenpää wrote:
>>     #. 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.
> "The kernel will silently ignore any :ref:`DTV-BANDWIDTH-HZ` setting ..."
>>   
>>        Such bandwidth estimation takes into account the symbol rate set with
>>        :ref:`DTV-SYMBOL-RATE`, and the rolloff factor, with is fixed for
> 
> Thanks.
> 

Hello,

What is the best way to send an update on this patch, now that patches 
3/4 and 4/4 have been applied, but 1/4 and 2/4 have not been applied?

Do I send v3 for the first two only?

Any guidance is greatly appreciated, since I am new to kernel development.

Best regards,

Hanne-Lotta Mäenpää

Re: [PATCH v2 1/4] docs: Improve grammar in Userspace API/DVB API

[Jonathan Corbet]

Hanne-Lotta Mäenpää <hannelotta@gmail.com> writes:

> On 5/23/25 08:58, Bagas Sanjaya wrote:
> What is the best way to send an update on this patch, now that patches 
> 3/4 and 4/4 have been applied, but 1/4 and 2/4 have not been applied?
>
> Do I send v3 for the first two only?

Yes, it has been long enough that you resend the two unapplied patches.
They are media-subsystem patches, so the media folks need to pick them
up.

Thanks,

jon