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

Hanne-Lotta Mäenpää
2025-05-21T15:38:13Z

Hello,

On 5/19/25 04:32, Bagas Sanjaya wrote:
> On Sat, May 17, 2025 at 04:27:10PM +0300, 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>
>> ---
>> 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
>
> Do you mean that devices used to be singleton in its functionality? Or having
> multiple functions?

On this line I did not include any changes. On the next line I have
added a comma. To answer your question though, the original author may
have meant that devices had less functionality earlier, which resulted
in multiple implementations of the common functions, and now with a lot
more functionality it makes sense to have a common interface for those.

>
>> -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.
>>
>> <snipped>...
>> 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.
>
> Improving grammar includes s/Taint/taint/?
>
> Confused...
>

Here the capitalized word is not in the beginning of a sentence or a
name, which is why lowercase would be correct.

Best regards,

Hanne-Lotta Mäenpää