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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <264386b3-075d-ef1d-e3b2-9a2937ca05cb@linux.intel.com>
Date: Mon, 19 May 2025 16:01:11 +0300 (EEST)
From: Ilpo Järvinen <ilpo.jarvinen@...ux.intel.com>
To: Bagas Sanjaya <bagasdotme@...il.com>
cc: 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, mario.limonciello@....com, 
    W_Armin@....de, Mark Pearson <mpearson-lenovo@...ebb.ca>, 
    linux-media@...r.kernel.org, LKML <linux-kernel@...r.kernel.org>, 
    linux-kernel-mentees@...ts.linux.dev
Subject: Re: [PATCH 3/4] docs: Improve grammar in Userspace API/fwctl

On Mon, 19 May 2025, 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@...il.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?
> 
> > -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...

To be fair, the changelog also said "Fix typos". So Bagas, do you mean 
"Taint" should be always capitalized? At least this doesn't support 
that position:

git grep -i  taint Documentation

-- 
 i.