* [PATCH] docs/dev-tools: fix a typo @ 2024-10-15 14:01 Haoyang Liu 2024-10-15 14:10 ` Dongliang Mu 2024-10-17 15:41 ` Jonathan Corbet 0 siblings, 2 replies; 8+ messages in thread From: Haoyang Liu @ 2024-10-15 14:01 UTC (permalink / raw) To: Alexander Potapenko, Marco Elver, Dmitry Vyukov, Jonathan Corbet Cc: hust-os-kernel-patches, Haoyang Liu, kasan-dev, workflows, linux-doc, linux-kernel 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 ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] docs/dev-tools: fix a typo 2024-10-15 14:01 [PATCH] docs/dev-tools: fix a typo Haoyang Liu @ 2024-10-15 14:10 ` Dongliang Mu 2024-10-15 14:32 ` Marco Elver 2024-10-17 15:41 ` Jonathan Corbet 1 sibling, 1 reply; 8+ messages in thread From: Dongliang Mu @ 2024-10-15 14:10 UTC (permalink / raw) To: Haoyang Liu Cc: Alexander Potapenko, Marco Elver, Dmitry Vyukov, Jonathan Corbet, hust-os-kernel-patches, kasan-dev, workflows, linux-doc, linux-kernel 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 > > ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] docs/dev-tools: fix a typo 2024-10-15 14:10 ` Dongliang Mu @ 2024-10-15 14:32 ` Marco Elver 2024-10-16 13:30 ` Dan Carpenter 0 siblings, 1 reply; 8+ messages in thread From: Marco Elver @ 2024-10-15 14:32 UTC (permalink / raw) To: Dongliang Mu Cc: Haoyang Liu, Alexander Potapenko, Dmitry Vyukov, Jonathan Corbet, hust-os-kernel-patches, kasan-dev, workflows, linux-doc, linux-kernel 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. ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] docs/dev-tools: fix a typo 2024-10-15 14:32 ` Marco Elver @ 2024-10-16 13:30 ` Dan Carpenter 2024-10-16 13:34 ` Alexander Potapenko 2024-10-16 14:52 ` Jonathan Corbet 0 siblings, 2 replies; 8+ messages in thread From: Dan Carpenter @ 2024-10-16 13:30 UTC (permalink / raw) To: Marco Elver Cc: Dongliang Mu, Haoyang Liu, Alexander Potapenko, Dmitry Vyukov, Jonathan Corbet, hust-os-kernel-patches, kasan-dev, workflows, linux-doc, linux-kernel 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 ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] docs/dev-tools: fix a typo 2024-10-16 13:30 ` Dan Carpenter @ 2024-10-16 13:34 ` Alexander Potapenko 2024-10-16 14:52 ` Jonathan Corbet 1 sibling, 0 replies; 8+ messages in thread From: Alexander Potapenko @ 2024-10-16 13:34 UTC (permalink / raw) To: Dan Carpenter Cc: Marco Elver, Dongliang Mu, Haoyang Liu, Dmitry Vyukov, Jonathan Corbet, hust-os-kernel-patches, kasan-dev, workflows, linux-doc, linux-kernel 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 ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] docs/dev-tools: fix a typo 2024-10-16 13:30 ` Dan Carpenter 2024-10-16 13:34 ` Alexander Potapenko @ 2024-10-16 14:52 ` Jonathan Corbet 2024-10-16 21:18 ` Shuah Khan 1 sibling, 1 reply; 8+ messages in thread From: Jonathan Corbet @ 2024-10-16 14:52 UTC (permalink / raw) To: Dan Carpenter, Marco Elver Cc: Dongliang Mu, Haoyang Liu, Alexander Potapenko, Dmitry Vyukov, hust-os-kernel-patches, kasan-dev, workflows, linux-doc, linux-kernel 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 ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] docs/dev-tools: fix a typo 2024-10-16 14:52 ` Jonathan Corbet @ 2024-10-16 21:18 ` Shuah Khan 0 siblings, 0 replies; 8+ messages in thread From: Shuah Khan @ 2024-10-16 21:18 UTC (permalink / raw) To: Jonathan Corbet, Dan Carpenter, Marco Elver Cc: Dongliang Mu, Haoyang Liu, Alexander Potapenko, Dmitry Vyukov, hust-os-kernel-patches, kasan-dev, workflows, linux-doc, linux-kernel, 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 ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH] docs/dev-tools: fix a typo 2024-10-15 14:01 [PATCH] docs/dev-tools: fix a typo Haoyang Liu 2024-10-15 14:10 ` Dongliang Mu @ 2024-10-17 15:41 ` Jonathan Corbet 1 sibling, 0 replies; 8+ messages in thread From: Jonathan Corbet @ 2024-10-17 15:41 UTC (permalink / raw) To: Haoyang Liu, Alexander Potapenko, Marco Elver, Dmitry Vyukov Cc: hust-os-kernel-patches, Haoyang Liu, kasan-dev, workflows, linux-doc, linux-kernel 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 ^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2024-10-17 15:41 UTC | newest] Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2024-10-15 14:01 [PATCH] docs/dev-tools: fix a typo Haoyang Liu 2024-10-15 14:10 ` Dongliang Mu 2024-10-15 14:32 ` Marco Elver 2024-10-16 13:30 ` Dan Carpenter 2024-10-16 13:34 ` Alexander Potapenko 2024-10-16 14:52 ` Jonathan Corbet 2024-10-16 21:18 ` Shuah Khan 2024-10-17 15:41 ` Jonathan Corbet
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox