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

3 views
Skip to first unread message

Haoyang Liu

unread,
Jul 25, 2024, 1:47:37 PM7/25/24
to Marco Elver, Dmitry Vyukov, Jonathan Corbet, hust-os-ker...@googlegroups.com, Haoyang Liu, kasa...@googlegroups.com, linu...@vger.kernel.org, linux-...@vger.kernel.org
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 <ttttur...@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

Dongliang Mu

unread,
Jul 25, 2024, 9:37:09 PM7/25/24
to Haoyang Liu, Marco Elver, Dmitry Vyukov, Jonathan Corbet, hust-os-ker...@googlegroups.com, kasa...@googlegroups.com, linu...@vger.kernel.org, linux-...@vger.kernel.org

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 <ttttur...@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 <dz...@hust.edu.cn>

Marco Elver

unread,
Jul 26, 2024, 4:38:53 AM7/26/24
to Dongliang Mu, Haoyang Liu, Dmitry Vyukov, Jonathan Corbet, hust-os-ker...@googlegroups.com, kasa...@googlegroups.com, linu...@vger.kernel.org, linux-...@vger.kernel.org
Acked-by: Marco Elver <el...@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.)

Dongliang Mu

unread,
Jul 26, 2024, 4:45:11 AM7/26/24
to Marco Elver, Haoyang Liu, Dmitry Vyukov, Jonathan Corbet, hust-os-ker...@googlegroups.com, kasa...@googlegroups.com, linu...@vger.kernel.org, linux-...@vger.kernel.org
Thanks Marco.

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

Haoyang Liu

unread,
Sep 3, 2024, 1:58:07 PM9/3/24
to Marco Elver, Dongliang Mu, Dmitry Vyukov, Jonathan Corbet, hust-os-ker...@googlegroups.com, kasa...@googlegroups.com, linu...@vger.kernel.org, linux-...@vger.kernel.org
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

Marco Elver

unread,
Sep 3, 2024, 2:02:25 PM9/3/24
to Haoyang Liu, Dongliang Mu, Dmitry Vyukov, Jonathan Corbet, hust-os-ker...@googlegroups.com, kasa...@googlegroups.com, linu...@vger.kernel.org, linux-...@vger.kernel.org
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

Haoyang Liu

unread,
Sep 3, 2024, 2:06:05 PM9/3/24
to Marco Elver, Dongliang Mu, Dmitry Vyukov, Jonathan Corbet, hust-os-ker...@googlegroups.com, kasa...@googlegroups.com, linu...@vger.kernel.org, linux-...@vger.kernel.org
Ok, I will send this patch to Jon and see if he can take it.


Thanks,

Haoyang

Haoyang Liu

unread,
Sep 3, 2024, 2:19:05 PM9/3/24
to Jonathan Corbet, hust-os-ker...@googlegroups.com
Hi jon,


Could you apply this patch to update the url in dev-tools/kcsan.rst?

Marco has acked this and suggested me to ask you to apply this patch
since it's a purely documentation change.


Thanks,

Haoyang

Dongliang Mu

unread,
Sep 3, 2024, 8:57:33 PM9/3/24
to Jonathan Corbet, Marco Elver, Dongliang Mu, Dmitry Vyukov, Haoyang Liu, hust-os-ker...@googlegroups.com, kasa...@googlegroups.com, linu...@vger.kernel.org, linux-...@vger.kernel.org
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
>
>

Jonathan Corbet

unread,
Sep 4, 2024, 10:05:02 AM9/4/24
to Haoyang Liu, Marco Elver, Dmitry Vyukov, hust-os-ker...@googlegroups.com, Haoyang Liu, kasa...@googlegroups.com, linu...@vger.kernel.org, linux-...@vger.kernel.org
Haoyang Liu <ttttur...@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 <ttttur...@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
Reply all
Reply to author
Forward
0 new messages