[PATCH] docs/dev-tools: fix a typo

[PATCH] docs/dev-tools: fix a typo

[Haoyang Liu]

fix a typo in dev-tools/kmsan.rst

Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
---
 Documentation/dev-tools/kmsan.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/kmsan.rst b/Documentation/dev-tools/kmsan.rst
index 6a48d96c5c85..0dc668b183f6 100644
--- a/Documentation/dev-tools/kmsan.rst
+++ b/Documentation/dev-tools/kmsan.rst
@@ -133,7 +133,7 @@ KMSAN shadow memory
 -------------------
 
 KMSAN associates a metadata byte (also called shadow byte) with every byte of
-kernel memory. A bit in the shadow byte is set iff the corresponding bit of the
+kernel memory. A bit in the shadow byte is set if the corresponding bit of the
 kernel memory byte is uninitialized. Marking the memory uninitialized (i.e.
 setting its shadow bytes to ``0xff``) is called poisoning, marking it
 initialized (setting the shadow bytes to ``0x00``) is called unpoisoning.
-- 
2.25.1

Re: [PATCH] docs/dev-tools: fix a typo

[Dongliang Mu]

On Tue, Oct 15, 2024 at 10:09 PM Haoyang Liu <tttturtleruss@hust.edu.cn> wrote:
>
> fix a typo in dev-tools/kmsan.rst
>
> Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
> ---
>  Documentation/dev-tools/kmsan.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/kmsan.rst b/Documentation/dev-tools/kmsan.rst
> index 6a48d96c5c85..0dc668b183f6 100644
> --- a/Documentation/dev-tools/kmsan.rst
> +++ b/Documentation/dev-tools/kmsan.rst
> @@ -133,7 +133,7 @@ KMSAN shadow memory
>  -------------------
>
>  KMSAN associates a metadata byte (also called shadow byte) with every byte of
> -kernel memory. A bit in the shadow byte is set iff the corresponding bit of the
> +kernel memory. A bit in the shadow byte is set if the corresponding bit of the

This is not a typo. iff is if and only if

Dongliang Mu

>  kernel memory byte is uninitialized. Marking the memory uninitialized (i.e.
>  setting its shadow bytes to ``0xff``) is called poisoning, marking it
>  initialized (setting the shadow bytes to ``0x00``) is called unpoisoning.
> --
> 2.25.1
>
>

Re: [PATCH] docs/dev-tools: fix a typo

[Marco Elver]

On Tue, 15 Oct 2024 at 16:11, Dongliang Mu <mudongliangabcd@gmail.com> wrote:
>
> On Tue, Oct 15, 2024 at 10:09 PM Haoyang Liu <tttturtleruss@hust.edu.cn> wrote:
> >
> > fix a typo in dev-tools/kmsan.rst
> >
> > Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
> > ---
> >  Documentation/dev-tools/kmsan.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/Documentation/dev-tools/kmsan.rst b/Documentation/dev-tools/kmsan.rst
> > index 6a48d96c5c85..0dc668b183f6 100644
> > --- a/Documentation/dev-tools/kmsan.rst
> > +++ b/Documentation/dev-tools/kmsan.rst
> > @@ -133,7 +133,7 @@ KMSAN shadow memory
> >  -------------------
> >
> >  KMSAN associates a metadata byte (also called shadow byte) with every byte of
> > -kernel memory. A bit in the shadow byte is set iff the corresponding bit of the
> > +kernel memory. A bit in the shadow byte is set if the corresponding bit of the
>
> This is not a typo. iff is if and only if

+1

https://en.wikipedia.org/wiki/If_and_only_if

Nack.

Re: [PATCH] docs/dev-tools: fix a typo

[Dan Carpenter]

On Tue, Oct 15, 2024 at 04:32:27PM +0200, 'Marco Elver' via HUST OS Kernel Contribution wrote:
> On Tue, 15 Oct 2024 at 16:11, Dongliang Mu <mudongliangabcd@gmail.com> wrote:
> >
> > On Tue, Oct 15, 2024 at 10:09 PM Haoyang Liu <tttturtleruss@hust.edu.cn> wrote:
> > >
> > > fix a typo in dev-tools/kmsan.rst
> > >
> > > Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
> > > ---
> > >  Documentation/dev-tools/kmsan.rst | 2 +-
> > >  1 file changed, 1 insertion(+), 1 deletion(-)
> > >
> > > diff --git a/Documentation/dev-tools/kmsan.rst b/Documentation/dev-tools/kmsan.rst
> > > index 6a48d96c5c85..0dc668b183f6 100644
> > > --- a/Documentation/dev-tools/kmsan.rst
> > > +++ b/Documentation/dev-tools/kmsan.rst
> > > @@ -133,7 +133,7 @@ KMSAN shadow memory
> > >  -------------------
> > >
> > >  KMSAN associates a metadata byte (also called shadow byte) with every byte of
> > > -kernel memory. A bit in the shadow byte is set iff the corresponding bit of the
> > > +kernel memory. A bit in the shadow byte is set if the corresponding bit of the
> >
> > This is not a typo. iff is if and only if
> 
> +1
> 
> https://en.wikipedia.org/wiki/If_and_only_if
> 

Does "iff" really add anything over regular "if"?  I would have thought the
"only if" could be assumed in this case.  Or if it's really necessary then we
could spell it out.

regards,
dan carpenter

Re: [PATCH] docs/dev-tools: fix a typo

[Alexander Potapenko]

On Wed, Oct 16, 2024 at 3:30 PM Dan Carpenter <dan.carpenter@linaro.org> wrote:
>
> On Tue, Oct 15, 2024 at 04:32:27PM +0200, 'Marco Elver' via HUST OS Kernel Contribution wrote:
> > On Tue, 15 Oct 2024 at 16:11, Dongliang Mu <mudongliangabcd@gmail.com> wrote:
> > >
> > > On Tue, Oct 15, 2024 at 10:09 PM Haoyang Liu <tttturtleruss@hust.edu.cn> wrote:
> > > >
> > > > fix a typo in dev-tools/kmsan.rst
> > > >
> > > > Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
> > > > ---
> > > >  Documentation/dev-tools/kmsan.rst | 2 +-
> > > >  1 file changed, 1 insertion(+), 1 deletion(-)
> > > >
> > > > diff --git a/Documentation/dev-tools/kmsan.rst b/Documentation/dev-tools/kmsan.rst
> > > > index 6a48d96c5c85..0dc668b183f6 100644
> > > > --- a/Documentation/dev-tools/kmsan.rst
> > > > +++ b/Documentation/dev-tools/kmsan.rst
> > > > @@ -133,7 +133,7 @@ KMSAN shadow memory
> > > >  -------------------
> > > >
> > > >  KMSAN associates a metadata byte (also called shadow byte) with every byte of
> > > > -kernel memory. A bit in the shadow byte is set iff the corresponding bit of the
> > > > +kernel memory. A bit in the shadow byte is set if the corresponding bit of the
> > >
> > > This is not a typo. iff is if and only if
> >
> > +1
> >
> > https://en.wikipedia.org/wiki/If_and_only_if
> >
>
> Does "iff" really add anything over regular "if"?  I would have thought the
> "only if" could be assumed in this case.  Or if it's really necessary then we
> could spell it out.

I think you are actually right, "if" should be just as fine in this case.

> regards,
> dan carpenter
>


-- 
Alexander Potapenko
Software Engineer

Google Germany GmbH
Erika-Mann-Straße, 33
80636 München

Geschäftsführer: Paul Manicle, Liana Sebastian
Registergericht und -nummer: Hamburg, HRB 86891
Sitz der Gesellschaft: Hamburg

Re: [PATCH] docs/dev-tools: fix a typo

[Jonathan Corbet]

Dan Carpenter <dan.carpenter@linaro.org> writes:

> On Tue, Oct 15, 2024 at 04:32:27PM +0200, 'Marco Elver' via HUST OS Kernel Contribution wrote:
>> On Tue, 15 Oct 2024 at 16:11, Dongliang Mu <mudongliangabcd@gmail.com> wrote:
>> >
>> > On Tue, Oct 15, 2024 at 10:09 PM Haoyang Liu <tttturtleruss@hust.edu.cn> wrote:
>> > >
>> > > fix a typo in dev-tools/kmsan.rst
>> > >
>> > > Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
>> > > ---
>> > >  Documentation/dev-tools/kmsan.rst | 2 +-
>> > >  1 file changed, 1 insertion(+), 1 deletion(-)
>> > >
>> > > diff --git a/Documentation/dev-tools/kmsan.rst b/Documentation/dev-tools/kmsan.rst
>> > > index 6a48d96c5c85..0dc668b183f6 100644
>> > > --- a/Documentation/dev-tools/kmsan.rst
>> > > +++ b/Documentation/dev-tools/kmsan.rst
>> > > @@ -133,7 +133,7 @@ KMSAN shadow memory
>> > >  -------------------
>> > >
>> > >  KMSAN associates a metadata byte (also called shadow byte) with every byte of
>> > > -kernel memory. A bit in the shadow byte is set iff the corresponding bit of the
>> > > +kernel memory. A bit in the shadow byte is set if the corresponding bit of the
>> >
>> > This is not a typo. iff is if and only if
>> 
>> +1
>> 
>> https://en.wikipedia.org/wiki/If_and_only_if
>> 
>
> Does "iff" really add anything over regular "if"?  I would have thought the
> "only if" could be assumed in this case.  Or if it's really necessary then we
> could spell it out.

Somebody "fixing" occurrences of "iff" are a regular occurrence; it's an
attractive nuisance for non-native speakers.  For that reason alone, I'm
coming to the conclusion that we should just spell it out when that is
the intended meaning.

jon

Re: [PATCH] docs/dev-tools: fix a typo

[Shuah Khan]

On 10/16/24 08:52, Jonathan Corbet wrote:
> Dan Carpenter <dan.carpenter@linaro.org> writes:
> 
>> On Tue, Oct 15, 2024 at 04:32:27PM +0200, 'Marco Elver' via HUST OS Kernel Contribution wrote:
>>> On Tue, 15 Oct 2024 at 16:11, Dongliang Mu <mudongliangabcd@gmail.com> wrote:
>>>>
>>>> On Tue, Oct 15, 2024 at 10:09 PM Haoyang Liu <tttturtleruss@hust.edu.cn> wrote:
>>>>>
>>>>> fix a typo in dev-tools/kmsan.rst
>>>>>
>>>>> Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
>>>>> ---
>>>>>   Documentation/dev-tools/kmsan.rst | 2 +-
>>>>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>>>>
>>>>> diff --git a/Documentation/dev-tools/kmsan.rst b/Documentation/dev-tools/kmsan.rst
>>>>> index 6a48d96c5c85..0dc668b183f6 100644
>>>>> --- a/Documentation/dev-tools/kmsan.rst
>>>>> +++ b/Documentation/dev-tools/kmsan.rst
>>>>> @@ -133,7 +133,7 @@ KMSAN shadow memory
>>>>>   -------------------
>>>>>
>>>>>   KMSAN associates a metadata byte (also called shadow byte) with every byte of
>>>>> -kernel memory. A bit in the shadow byte is set iff the corresponding bit of the
>>>>> +kernel memory. A bit in the shadow byte is set if the corresponding bit of the
>>>>
>>>> This is not a typo. iff is if and only if
>>>
>>> +1
>>>
>>> https://en.wikipedia.org/wiki/If_and_only_if
>>>
>>
>> Does "iff" really add anything over regular "if"?  I would have thought the
>> "only if" could be assumed in this case.  Or if it's really necessary then we
>> could spell it out.
> 
> Somebody "fixing" occurrences of "iff" are a regular occurrence; it's an
> attractive nuisance for non-native speakers.  For that reason alone, I'm
> coming to the conclusion that we should just spell it out when that is
> the intended meaning.
> 

+1 on this. It would be too attractive for new developers.
It helps us not spend cycles on reviewing and applying the patches.

thanks,
-- Shuah

Re: [PATCH] docs/dev-tools: fix a typo

[Jonathan Corbet]

Haoyang Liu <tttturtleruss@hust.edu.cn> writes:

> fix a typo in dev-tools/kmsan.rst
>
> Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
> ---
>  Documentation/dev-tools/kmsan.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/kmsan.rst b/Documentation/dev-tools/kmsan.rst
> index 6a48d96c5c85..0dc668b183f6 100644
> --- a/Documentation/dev-tools/kmsan.rst
> +++ b/Documentation/dev-tools/kmsan.rst
> @@ -133,7 +133,7 @@ KMSAN shadow memory
>  -------------------
>  
>  KMSAN associates a metadata byte (also called shadow byte) with every byte of
> -kernel memory. A bit in the shadow byte is set iff the corresponding bit of the
> +kernel memory. A bit in the shadow byte is set if the corresponding bit of the
>  kernel memory byte is uninitialized. Marking the memory uninitialized (i.e.
>  setting its shadow bytes to ``0xff``) is called poisoning, marking it
>  initialized (setting the shadow bytes to ``0x00``) is called unpoisoning.

So I have applied this, since "iff" is clearly confusing to a lot of
readers even iff it's correct.

Thanks,

jon