[PATCH] docs: update dev-tools/kcsan.rst url about KTSAN

[PATCH] docs: update dev-tools/kcsan.rst url about KTSAN

[Haoyang Liu]

The KTSAN doc has moved to
https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md.
Update the url in kcsan.rst accordingly.

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

diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
index 02143f060b22..d81c42d1063e 100644
--- a/Documentation/dev-tools/kcsan.rst
+++ b/Documentation/dev-tools/kcsan.rst
@@ -361,7 +361,8 @@ Alternatives Considered
 -----------------------
 
 An alternative data race detection approach for the kernel can be found in the
-`Kernel Thread Sanitizer (KTSAN) <https://github.com/google/ktsan/wiki>`_.
+`Kernel Thread Sanitizer (KTSAN)
+<https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md>`_.
 KTSAN is a happens-before data race detector, which explicitly establishes the
 happens-before order between memory operations, which can then be used to
 determine data races as defined in `Data Races`_.
-- 
2.25.1

Re: [PATCH] docs: update dev-tools/kcsan.rst url about KTSAN

[Dongliang Mu]

On 2024/7/26 01:46, Haoyang Liu wrote:
> The KTSAN doc has moved to
> https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md.
> Update the url in kcsan.rst accordingly.
>
> Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>

Although the old link is still accessible, I agree to use the newer one.

If this patch is merged, you need to change your Chinese version to 
catch up.

Reviewed-by: Dongliang Mu <dzm91@hust.edu.cn>

> ---
>   Documentation/dev-tools/kcsan.rst | 3 ++-
>   1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
> index 02143f060b22..d81c42d1063e 100644
> --- a/Documentation/dev-tools/kcsan.rst
> +++ b/Documentation/dev-tools/kcsan.rst
> @@ -361,7 +361,8 @@ Alternatives Considered
>   -----------------------
>   
>   An alternative data race detection approach for the kernel can be found in the
> -`Kernel Thread Sanitizer (KTSAN) <https://github.com/google/ktsan/wiki>`_.
> +`Kernel Thread Sanitizer (KTSAN)
> +<https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md>`_.
>   KTSAN is a happens-before data race detector, which explicitly establishes the
>   happens-before order between memory operations, which can then be used to
>   determine data races as defined in `Data Races`_.

Re: [PATCH] docs: update dev-tools/kcsan.rst url about KTSAN

[Marco Elver]

On Fri, 26 Jul 2024 at 03:36, Dongliang Mu <dzm91@hust.edu.cn> wrote:
>
>
> On 2024/7/26 01:46, Haoyang Liu wrote:
> > The KTSAN doc has moved to
> > https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md.
> > Update the url in kcsan.rst accordingly.
> >
> > Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
>
> Although the old link is still accessible, I agree to use the newer one.
>
> If this patch is merged, you need to change your Chinese version to
> catch up.
>
> Reviewed-by: Dongliang Mu <dzm91@hust.edu.cn>
>
> > ---
> >   Documentation/dev-tools/kcsan.rst | 3 ++-
> >   1 file changed, 2 insertions(+), 1 deletion(-)
> >
> > diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
> > index 02143f060b22..d81c42d1063e 100644
> > --- a/Documentation/dev-tools/kcsan.rst
> > +++ b/Documentation/dev-tools/kcsan.rst
> > @@ -361,7 +361,8 @@ Alternatives Considered
> >   -----------------------
> >
> >   An alternative data race detection approach for the kernel can be found in the
> > -`Kernel Thread Sanitizer (KTSAN) <https://github.com/google/ktsan/wiki>`_.
> > +`Kernel Thread Sanitizer (KTSAN)
> > +<https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md>`_.
> >   KTSAN is a happens-before data race detector, which explicitly establishes the
> >   happens-before order between memory operations, which can then be used to
> >   determine data races as defined in `Data Races`_.

Acked-by: Marco Elver <elver@google.com>

Do you have a tree to take your other patch ("docs/zh_CN: Add
dev-tools/kcsan Chinese translation") through? If so, I would suggest
that you ask that maintainer to take both patches, this and the
Chinese translation patch. (Otherwise, I will queue this patch to be
remembered but it'll be a while until it reaches mainline.)

Re: [PATCH] docs: update dev-tools/kcsan.rst url about KTSAN

[Dongliang Mu]

On 7/26/24 16:38, Marco Elver wrote:
> On Fri, 26 Jul 2024 at 03:36, Dongliang Mu <dzm91@hust.edu.cn> wrote:
>>
>> On 2024/7/26 01:46, Haoyang Liu wrote:
>>> The KTSAN doc has moved to
>>> https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md.
>>> Update the url in kcsan.rst accordingly.
>>>
>>> Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
>> Although the old link is still accessible, I agree to use the newer one.
>>
>> If this patch is merged, you need to change your Chinese version to
>> catch up.
>>
>> Reviewed-by: Dongliang Mu <dzm91@hust.edu.cn>
>>
>>> ---
>>>    Documentation/dev-tools/kcsan.rst | 3 ++-
>>>    1 file changed, 2 insertions(+), 1 deletion(-)
>>>
>>> diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
>>> index 02143f060b22..d81c42d1063e 100644
>>> --- a/Documentation/dev-tools/kcsan.rst
>>> +++ b/Documentation/dev-tools/kcsan.rst
>>> @@ -361,7 +361,8 @@ Alternatives Considered
>>>    -----------------------
>>>
>>>    An alternative data race detection approach for the kernel can be found in the
>>> -`Kernel Thread Sanitizer (KTSAN) <https://github.com/google/ktsan/wiki>`_.
>>> +`Kernel Thread Sanitizer (KTSAN)
>>> +<https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md>`_.
>>>    KTSAN is a happens-before data race detector, which explicitly establishes the
>>>    happens-before order between memory operations, which can then be used to
>>>    determine data races as defined in `Data Races`_.
> Acked-by: Marco Elver <elver@google.com>
>
> Do you have a tree to take your other patch ("docs/zh_CN: Add
> dev-tools/kcsan Chinese translation") through? If so, I would suggest

Thanks Marco.

That patch will be merged to lwn tree maintained by Jon if all issues 
are resolved.

> that you ask that maintainer to take both patches, this and the
> Chinese translation patch. (Otherwise, I will queue this patch to be
> remembered but it'll be a while until it reaches mainline.)

Re: [PATCH] docs: update dev-tools/kcsan.rst url about KTSAN

[Haoyang Liu]

在 2024/7/26 16:38, Marco Elver 写道:
> On Fri, 26 Jul 2024 at 03:36, Dongliang Mu <dzm91@hust.edu.cn> wrote:
>>
>> On 2024/7/26 01:46, Haoyang Liu wrote:
>>> The KTSAN doc has moved to
>>> https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md.
>>> Update the url in kcsan.rst accordingly.
>>>
>>> Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
>> Although the old link is still accessible, I agree to use the newer one.
>>
>> If this patch is merged, you need to change your Chinese version to
>> catch up.
>>
>> Reviewed-by: Dongliang Mu <dzm91@hust.edu.cn>
>>
>>> ---
>>>    Documentation/dev-tools/kcsan.rst | 3 ++-
>>>    1 file changed, 2 insertions(+), 1 deletion(-)
>>>
>>> diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
>>> index 02143f060b22..d81c42d1063e 100644
>>> --- a/Documentation/dev-tools/kcsan.rst
>>> +++ b/Documentation/dev-tools/kcsan.rst
>>> @@ -361,7 +361,8 @@ Alternatives Considered
>>>    -----------------------
>>>
>>>    An alternative data race detection approach for the kernel can be found in the
>>> -`Kernel Thread Sanitizer (KTSAN) <https://github.com/google/ktsan/wiki>`_.
>>> +`Kernel Thread Sanitizer (KTSAN)
>>> +<https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md>`_.
>>>    KTSAN is a happens-before data race detector, which explicitly establishes the
>>>    happens-before order between memory operations, which can then be used to
>>>    determine data races as defined in `Data Races`_.
> Acked-by: Marco Elver <elver@google.com>
>
> Do you have a tree to take your other patch ("docs/zh_CN: Add
> dev-tools/kcsan Chinese translation") through? If so, I would suggest
> that you ask that maintainer to take both patches, this and the
> Chinese translation patch. (Otherwise, I will queue this patch to be
> remembered but it'll be a while until it reaches mainline.)

Hi, Marco.


The patch "docs/zh_CN: Add dev-tools/kcsan Chinese translation" has been 
applied, but they didn't take this one. How about you take it into your 
tree?


Thanks,

Haoyang

Re: [PATCH] docs: update dev-tools/kcsan.rst url about KTSAN

[Marco Elver]

On Tue, 3 Sept 2024 at 19:58, Haoyang Liu <tttturtleruss@hust.edu.cn> wrote:
>
>
> 在 2024/7/26 16:38, Marco Elver 写道:
> > On Fri, 26 Jul 2024 at 03:36, Dongliang Mu <dzm91@hust.edu.cn> wrote:
> >>
> >> On 2024/7/26 01:46, Haoyang Liu wrote:
> >>> The KTSAN doc has moved to
> >>> https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md.
> >>> Update the url in kcsan.rst accordingly.
> >>>
> >>> Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
> >> Although the old link is still accessible, I agree to use the newer one.
> >>
> >> If this patch is merged, you need to change your Chinese version to
> >> catch up.
> >>
> >> Reviewed-by: Dongliang Mu <dzm91@hust.edu.cn>
> >>
> >>> ---
> >>>    Documentation/dev-tools/kcsan.rst | 3 ++-
> >>>    1 file changed, 2 insertions(+), 1 deletion(-)
> >>>
> >>> diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
> >>> index 02143f060b22..d81c42d1063e 100644
> >>> --- a/Documentation/dev-tools/kcsan.rst
> >>> +++ b/Documentation/dev-tools/kcsan.rst
> >>> @@ -361,7 +361,8 @@ Alternatives Considered
> >>>    -----------------------
> >>>
> >>>    An alternative data race detection approach for the kernel can be found in the
> >>> -`Kernel Thread Sanitizer (KTSAN) <https://github.com/google/ktsan/wiki>`_.
> >>> +`Kernel Thread Sanitizer (KTSAN)
> >>> +<https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md>`_.
> >>>    KTSAN is a happens-before data race detector, which explicitly establishes the
> >>>    happens-before order between memory operations, which can then be used to
> >>>    determine data races as defined in `Data Races`_.
> > Acked-by: Marco Elver <elver@google.com>
> >
> > Do you have a tree to take your other patch ("docs/zh_CN: Add
> > dev-tools/kcsan Chinese translation") through? If so, I would suggest
> > that you ask that maintainer to take both patches, this and the
> > Chinese translation patch. (Otherwise, I will queue this patch to be
> > remembered but it'll be a while until it reaches mainline.)
>
> Hi, Marco.
>
>
> The patch "docs/zh_CN: Add dev-tools/kcsan Chinese translation" has been
> applied, but they didn't take this one. How about you take it into your
> tree?

I don't have a tree.

Since this is purely documentation changes, could Jon take it into the
Documentation tree?
Otherwise we have to ask Paul to take it into -rcu.

Thanks,
-- Marco

Re: [PATCH] docs: update dev-tools/kcsan.rst url about KTSAN

[Haoyang Liu]

在 2024/9/4 2:01, Marco Elver 写道:
> On Tue, 3 Sept 2024 at 19:58, Haoyang Liu <tttturtleruss@hust.edu.cn> wrote:
>>
>> 在 2024/7/26 16:38, Marco Elver 写道:
>>> On Fri, 26 Jul 2024 at 03:36, Dongliang Mu <dzm91@hust.edu.cn> wrote:
>>>> On 2024/7/26 01:46, Haoyang Liu wrote:
>>>>> The KTSAN doc has moved to
>>>>> https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md.
>>>>> Update the url in kcsan.rst accordingly.
>>>>>
>>>>> Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
>>>> Although the old link is still accessible, I agree to use the newer one.
>>>>
>>>> If this patch is merged, you need to change your Chinese version to
>>>> catch up.
>>>>
>>>> Reviewed-by: Dongliang Mu <dzm91@hust.edu.cn>
>>>>
>>>>> ---
>>>>>     Documentation/dev-tools/kcsan.rst | 3 ++-
>>>>>     1 file changed, 2 insertions(+), 1 deletion(-)
>>>>>
>>>>> diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
>>>>> index 02143f060b22..d81c42d1063e 100644
>>>>> --- a/Documentation/dev-tools/kcsan.rst
>>>>> +++ b/Documentation/dev-tools/kcsan.rst
>>>>> @@ -361,7 +361,8 @@ Alternatives Considered
>>>>>     -----------------------
>>>>>
>>>>>     An alternative data race detection approach for the kernel can be found in the
>>>>> -`Kernel Thread Sanitizer (KTSAN) <https://github.com/google/ktsan/wiki>`_.
>>>>> +`Kernel Thread Sanitizer (KTSAN)
>>>>> +<https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md>`_.
>>>>>     KTSAN is a happens-before data race detector, which explicitly establishes the
>>>>>     happens-before order between memory operations, which can then be used to
>>>>>     determine data races as defined in `Data Races`_.
>>> Acked-by: Marco Elver <elver@google.com>
>>>
>>> Do you have a tree to take your other patch ("docs/zh_CN: Add
>>> dev-tools/kcsan Chinese translation") through? If so, I would suggest
>>> that you ask that maintainer to take both patches, this and the
>>> Chinese translation patch. (Otherwise, I will queue this patch to be
>>> remembered but it'll be a while until it reaches mainline.)
>> Hi, Marco.
>>
>>
>> The patch "docs/zh_CN: Add dev-tools/kcsan Chinese translation" has been
>> applied, but they didn't take this one. How about you take it into your
>> tree?
> I don't have a tree.
>
> Since this is purely documentation changes, could Jon take it into the
> Documentation tree?
> Otherwise we have to ask Paul to take it into -rcu.
>
> Thanks,
> -- Marco

Ok, I will send this patch to Jon and see if he can take it.


Thanks,

Haoyang

Re: [PATCH] docs: update dev-tools/kcsan.rst url about KTSAN

[Dongliang Mu]

On Wed, Sep 4, 2024 at 2:05 AM Haoyang Liu <tttturtleruss@hust.edu.cn> wrote:
>
>
> 在 2024/9/4 2:01, Marco Elver 写道:
> > On Tue, 3 Sept 2024 at 19:58, Haoyang Liu <tttturtleruss@hust.edu.cn> wrote:
> >>
> >> 在 2024/7/26 16:38, Marco Elver 写道:
> >>> On Fri, 26 Jul 2024 at 03:36, Dongliang Mu <dzm91@hust.edu.cn> wrote:
> >>>> On 2024/7/26 01:46, Haoyang Liu wrote:
> >>>>> The KTSAN doc has moved to
> >>>>> https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md.
> >>>>> Update the url in kcsan.rst accordingly.
> >>>>>
> >>>>> Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
> >>>> Although the old link is still accessible, I agree to use the newer one.
> >>>>
> >>>> If this patch is merged, you need to change your Chinese version to
> >>>> catch up.
> >>>>
> >>>> Reviewed-by: Dongliang Mu <dzm91@hust.edu.cn>
> >>>>
> >>>>> ---
> >>>>>     Documentation/dev-tools/kcsan.rst | 3 ++-
> >>>>>     1 file changed, 2 insertions(+), 1 deletion(-)
> >>>>>
> >>>>> diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
> >>>>> index 02143f060b22..d81c42d1063e 100644
> >>>>> --- a/Documentation/dev-tools/kcsan.rst
> >>>>> +++ b/Documentation/dev-tools/kcsan.rst
> >>>>> @@ -361,7 +361,8 @@ Alternatives Considered
> >>>>>     -----------------------
> >>>>>
> >>>>>     An alternative data race detection approach for the kernel can be found in the
> >>>>> -`Kernel Thread Sanitizer (KTSAN) <https://github.com/google/ktsan/wiki>`_.
> >>>>> +`Kernel Thread Sanitizer (KTSAN)
> >>>>> +<https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md>`_.
> >>>>>     KTSAN is a happens-before data race detector, which explicitly establishes the
> >>>>>     happens-before order between memory operations, which can then be used to
> >>>>>     determine data races as defined in `Data Races`_.
> >>> Acked-by: Marco Elver <elver@google.com>
> >>>
> >>> Do you have a tree to take your other patch ("docs/zh_CN: Add
> >>> dev-tools/kcsan Chinese translation") through? If so, I would suggest
> >>> that you ask that maintainer to take both patches, this and the
> >>> Chinese translation patch. (Otherwise, I will queue this patch to be
> >>> remembered but it'll be a while until it reaches mainline.)
> >> Hi, Marco.
> >>
> >>
> >> The patch "docs/zh_CN: Add dev-tools/kcsan Chinese translation" has been
> >> applied, but they didn't take this one. How about you take it into your
> >> tree?
> > I don't have a tree.
> >
> > Since this is purely documentation changes, could Jon take it into the
> > Documentation tree?
> > Otherwise we have to ask Paul to take it into -rcu.
> >
> > Thanks,
> > -- Marco
>
> Ok, I will send this patch to Jon and see if he can take it.

Hi Jon,

Could you please take this patch to lwn tree maintained by you?

P.S., it seems Jon is in the cc list previously.

>
>
> Thanks,
>
> Haoyang
>
>

Re: [PATCH] docs: update dev-tools/kcsan.rst url about KTSAN

[Jonathan Corbet]

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

> The KTSAN doc has moved to
> https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md.
> Update the url in kcsan.rst accordingly.
>
> Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
> ---
>  Documentation/dev-tools/kcsan.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
> index 02143f060b22..d81c42d1063e 100644
> --- a/Documentation/dev-tools/kcsan.rst
> +++ b/Documentation/dev-tools/kcsan.rst
> @@ -361,7 +361,8 @@ Alternatives Considered
>  -----------------------
>  
>  An alternative data race detection approach for the kernel can be found in the
> -`Kernel Thread Sanitizer (KTSAN) <https://github.com/google/ktsan/wiki>`_.
> +`Kernel Thread Sanitizer (KTSAN)
> +<https://github.com/google/kernel-sanitizers/blob/master/KTSAN.md>`_.
>  KTSAN is a happens-before data race detector, which explicitly establishes the

Applied, thanks.

jon