From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from out-182.mta1.migadu.com (out-182.mta1.migadu.com [95.215.58.182])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id A064F2063DD
	for <linux-kernel-mentees@lists.linux.dev>; Thu,  6 Mar 2025 21:12:16 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=95.215.58.182
ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1741295539; cv=none; b=iWOCisbAwaeFYwaQdxJefyb6bUS3JZ29WQUmi6DZNXcUkJeUqDj9frlv1uC2d8xvUrFhxR70xx0nAJ328NR4akoy0sG/CNqxUh6NfbsAImmqPPRZxAlV0B3QoHS5w3tfKP3DfakTNP+lmvXn6BC8epJ2JUyW2eUvYTsoKJfoc58=
ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1741295539; c=relaxed/simple;
	bh=h+VIqaX0d9abQ3DgSDf9PJxmMtWd3EZWAdJBHQKExe4=;
	h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:To:Cc; b=BFRnt3pum46WGKSOLEurkr7YbrRjxA2guvaHMiV5QQIloVcbtcTQF8kAvLHkPlYzOn5X2ELD/PlMIEgfUAQq2S+xpmaCAFYS7Nc8Qdl2lCVC6+OEkD7emYx9dJ6X9w+k10DbXIGYG8TGN25oDk5fsuvqCHm+mMKsKjRv/ipfDxs=
ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=iencinas.com; spf=pass smtp.mailfrom=iencinas.com; dkim=pass (2048-bit key) header.d=iencinas.com header.i=@iencinas.com header.b=XVN4ljCe; arc=none smtp.client-ip=95.215.58.182
Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=iencinas.com
Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=iencinas.com
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=iencinas.com header.i=@iencinas.com header.b="XVN4ljCe"
X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers.
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iencinas.com;
	s=key1; t=1741295521;
	h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
	 to:to:cc:cc:mime-version:mime-version:content-type:content-type:
	 content-transfer-encoding:content-transfer-encoding;
	bh=y3UeIRikRnYRQC1pPCbxniJMgfci1KvvEP9uumjgL+U=;
	b=XVN4ljCeqOBTo6h9ilroA0XqRUI4a5PIl8nHzuRYVep5tjK5EVhCd9EMldPg9Q+IpW6okJ
	xiRBNwncleDyexs5zZrJgC9yofcmBwfjeBNo2vtLzMWtY210Upk1Fg1Kg05s+AIgyWQ3U5
	7eVyKZ+enbEBYFUHLlL3JC/EBcinRHbQ5wmI+dqgy7RFspS56DRBgnDbROQVE1CXmyemO/
	/TmLC6p9ZN25yuMCGXvIqe2iyLniERd/herFvWjtrVc8ApBLhyiNq9Q9U2MdnYYHtr9ENo
	QjR/KvYNc1TgdPtaPctkstLvNAizyYqmoC8kXv1FPMr81UdKwtJuzjywwwW/wQ==
From: Ignacio Encinas <ignacio@iencinas.com>
Date: Thu, 06 Mar 2025 22:11:45 +0100
Subject: [PATCH] Documentation: kcsan: fix "Plain Accesses and Data Races"
 URL in kcsan.rst
Precedence: bulk
X-Mailing-List: linux-kernel-mentees@lists.linux.dev
List-Id: <linux-kernel-mentees.lists.linux.dev>
List-Subscribe: <mailto:linux-kernel-mentees+subscribe@lists.linux.dev>
List-Unsubscribe: <mailto:linux-kernel-mentees+unsubscribe@lists.linux.dev>
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20250306-fix-plain-access-url-v1-1-9c653800f9e0@iencinas.com>
X-B4-Tracking: v=1; b=H4sIAJAPymcC/x2MSQqAMAwAv1JyNlD36lfEQ6hRA1KlQRHEv1s8D
 szMA8pRWKE3D0S+RGUPCfLMgF8pLIwyJYbCFrUtbYOz3HhsJAHJe1bFM27oiF2V80xV20FKj8j
 J+7fD+L4fi0brDmYAAAA=
X-Change-ID: 20250306-fix-plain-access-url-8ae841efa479
To: linux-kernel-mentees@lists.linux.dev, skhan@linuxfoundation.org, 
 Marco Elver <elver@google.com>, Dmitry Vyukov <dvyukov@google.com>, 
 Jonathan Corbet <corbet@lwn.net>
Cc: kasan-dev@googlegroups.com, workflows@vger.kernel.org, 
 linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, 
 Ignacio Encinas <ignacio@iencinas.com>
X-Migadu-Flow: FLOW_OUT

Make the URL point to the "Plain Accesses and Data Races" section again
and prevent it from becoming stale by adding a commit id to it.

Signed-off-by: Ignacio Encinas <ignacio@iencinas.com>
---
I noticed this while reviewing the documentation.

The "fix" isn't perfect as the link might become stale because it points
to a fixed commit. Alternatively, we could lose the line number
altogether.
---
 Documentation/dev-tools/kcsan.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
index d81c42d1063eab5db0cba1786de287406ca3ebe7..8575178aa87f1402d777af516f5c0e2fc8a3379d 100644
--- a/Documentation/dev-tools/kcsan.rst
+++ b/Documentation/dev-tools/kcsan.rst
@@ -203,7 +203,7 @@ they happen concurrently in different threads, and at least one of them is a
 least one is a write. For a more thorough discussion and definition, see `"Plain
 Accesses and Data Races" in the LKMM`_.
 
-.. _"Plain Accesses and Data Races" in the LKMM: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/memory-model/Documentation/explanation.txt#n1922
+.. _"Plain Accesses and Data Races" in the LKMM: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/memory-model/Documentation/explanation.txt?id=8f6629c004b193d23612641c3607e785819e97ab#n2164
 
 Relationship with the Linux-Kernel Memory Consistency Model (LKMM)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

---
base-commit: 19b100b0116d703b9529f7bbbf797428de51816a
change-id: 20250306-fix-plain-access-url-8ae841efa479

Best regards,
-- 
Ignacio Encinas <ignacio@iencinas.com>


From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from ms.lwn.net (ms.lwn.net [45.79.88.28])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id 166521F0E45
	for <linux-kernel-mentees@lists.linux.dev>; Wed, 12 Mar 2025 22:36:20 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=45.79.88.28
ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1741818982; cv=none; b=m71wcSuDB6o06XGUx6v7xnY0ldo5tf+EfafrD7lMeVWj4ZwcOTUzqklY3uqI26awqmrCOKgMFpVVvKOMPKgq1+SI1xupdhJhx1CZqm5o5s96eq7mFoO7Aaab08+DxuQPgtkkuO8bItZCdTD6jHwuQO7RkbYldfiN5BQRGY72Ij0=
ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1741818982; c=relaxed/simple;
	bh=BaVWbSQENie34pWfic/pbRF/wriQKKMjAg34hMpBRvY=;
	h=From:To:Cc:Subject:In-Reply-To:References:Date:Message-ID:
	 MIME-Version:Content-Type; b=J8TpyL8zRuYrPN1U9PJYwz8jjFYTboXrjC8SRNGIJgfE0jSWZkrepdMk0MhfcUY9HFw4czVD7RL8mVdXYq30sqoJjvoXlQ88+fCV+KqJ7LWFuFCNo+DXo+VN41gCKzrAfdtcYpZhbNJPuniMaXdzcoJMzq/DtXs54PvAkNPctF0=
ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net; spf=pass smtp.mailfrom=lwn.net; dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b=mCGKV3ac; arc=none smtp.client-ip=45.79.88.28
Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net
Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=lwn.net
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b="mCGKV3ac"
DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 0FB7E41063
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203;
	t=1741818980; bh=GTMfbvfPe3rGQpfvz+NRGN74Tvu8HffllNDpfQa9owA=;
	h=From:To:Cc:Subject:In-Reply-To:References:Date:From;
	b=mCGKV3acK+jLSNTwFG4FSzwiDSq690fcbkqEMydifNSaBFsaxZPO6dPWlKhLMmIib
	 yFOIUY7n9Z2bwDy9Jn5D+4eB+A13pMdkkTB19Ii9WgmL/Rl++ppWhTuS+vMCrDJXtb
	 FTXCQEb34bWO73R7fO+Vzos7qbgGRrrKENjNBoJN06yJtO1TpcP/wAuCXgBq8FyWxm
	 sQQPgsR6oA3oeHZ9dvJ1gUJFtZUQmjjCEhk12rqGeR6QtRfKlrDEOWVLuNquvmMKst
	 /+P8M4UAUQ+QTtmjf5tBNXiFSiy4NemJeMaOiSC49TNSuxHDfMQNbCGotIIbAHvYZy
	 KP8ino3r31b+g==
Received: from localhost (unknown [IPv6:2601:280:4600:2da9::1fe])
	(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
	 key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256)
	(No client certificate requested)
	by ms.lwn.net (Postfix) with ESMTPSA id 0FB7E41063;
	Wed, 12 Mar 2025 22:36:20 +0000 (UTC)
From: Jonathan Corbet <corbet@lwn.net>
To: Ignacio Encinas <ignacio@iencinas.com>,
 linux-kernel-mentees@lists.linux.dev, skhan@linuxfoundation.org, Marco
 Elver <elver@google.com>, Dmitry Vyukov <dvyukov@google.com>
Cc: kasan-dev@googlegroups.com, workflows@vger.kernel.org,
 linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Ignacio Encinas
 <ignacio@iencinas.com>
Subject: Re: [PATCH] Documentation: kcsan: fix "Plain Accesses and Data
 Races" URL in kcsan.rst
In-Reply-To: <20250306-fix-plain-access-url-v1-1-9c653800f9e0@iencinas.com>
References: <20250306-fix-plain-access-url-v1-1-9c653800f9e0@iencinas.com>
Date: Wed, 12 Mar 2025 16:36:19 -0600
Message-ID: <87o6y5lvvg.fsf@trenco.lwn.net>
Precedence: bulk
X-Mailing-List: linux-kernel-mentees@lists.linux.dev
List-Id: <linux-kernel-mentees.lists.linux.dev>
List-Subscribe: <mailto:linux-kernel-mentees+subscribe@lists.linux.dev>
List-Unsubscribe: <mailto:linux-kernel-mentees+unsubscribe@lists.linux.dev>
MIME-Version: 1.0
Content-Type: text/plain

Ignacio Encinas <ignacio@iencinas.com> writes:

> Make the URL point to the "Plain Accesses and Data Races" section again
> and prevent it from becoming stale by adding a commit id to it.
>
> Signed-off-by: Ignacio Encinas <ignacio@iencinas.com>
> ---
> I noticed this while reviewing the documentation.
>
> The "fix" isn't perfect as the link might become stale because it points
> to a fixed commit. Alternatively, we could lose the line number
> altogether.
> ---
>  Documentation/dev-tools/kcsan.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
> index d81c42d1063eab5db0cba1786de287406ca3ebe7..8575178aa87f1402d777af516f5c0e2fc8a3379d 100644
> --- a/Documentation/dev-tools/kcsan.rst
> +++ b/Documentation/dev-tools/kcsan.rst
> @@ -203,7 +203,7 @@ they happen concurrently in different threads, and at least one of them is a
>  least one is a write. For a more thorough discussion and definition, see `"Plain
>  Accesses and Data Races" in the LKMM`_.
>  
> -.. _"Plain Accesses and Data Races" in the LKMM: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/memory-model/Documentation/explanation.txt#n1922
> +.. _"Plain Accesses and Data Races" in the LKMM: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/memory-model/Documentation/explanation.txt?id=8f6629c004b193d23612641c3607e785819e97ab#n2164
>  

This seems like an improvement over what we have, so I've applied it.

It would be best, of course, to get the memory-model documentation
properly into our built docs...someday...

Thanks,

jon

From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from out-170.mta1.migadu.com (out-170.mta1.migadu.com [95.215.58.170])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id 18C80202973
	for <linux-kernel-mentees@lists.linux.dev>; Fri, 14 Mar 2025 16:30:18 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=95.215.58.170
ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1741969821; cv=none; b=KaUKK8o8+/Z+8SgQHPJOTEvwJdLB+hsaBfZ+0BSyQ8uoDsMlJ+381Nzx+qP32Gj1K5eb8v00C7ZCA6XHR5Q2S14q4svP+kbFMTg1zznfQ6FEnkjb5RgHnmuZtyiQSHMK6YhS8uJbpM3qpFsWo+GPbUsrkJ7sUCR6+MYapBXUOkA=
ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1741969821; c=relaxed/simple;
	bh=Rf3Y2t5DfgJzg/9Slo+edGTDwDk+9738sTXLJVoqKHY=;
	h=Message-ID:Date:MIME-Version:Subject:To:Cc:References:From:
	 In-Reply-To:Content-Type; b=G9tJOga5zzlBtmbRJK9NbbJtKBxmL0V3kD50SOrlopmDAGTuMIK7TmWkNehhGGB3CPRj3H1vKCkffssA9r2GSlmsiTWyFEhrIxEMLwsXfL6GPluPwrbz6zyTKb45LNc9hKYVjX1m9MXnO3vaYz4rpkkD46ZPgHdW/ZPveVV3b6U=
ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=iencinas.com; spf=pass smtp.mailfrom=iencinas.com; dkim=pass (2048-bit key) header.d=iencinas.com header.i=@iencinas.com header.b=pm4irdM4; arc=none smtp.client-ip=95.215.58.170
Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=iencinas.com
Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=iencinas.com
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=iencinas.com header.i=@iencinas.com header.b="pm4irdM4"
Message-ID: <1d66a62e-faee-4604-9136-f90eddcfa7c0@iencinas.com>
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iencinas.com;
	s=key1; t=1741969806;
	h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
	 to:to:cc:cc:mime-version:mime-version:content-type:content-type:
	 content-transfer-encoding:content-transfer-encoding:
	 in-reply-to:in-reply-to:references:references:autocrypt:autocrypt;
	bh=Rf3Y2t5DfgJzg/9Slo+edGTDwDk+9738sTXLJVoqKHY=;
	b=pm4irdM4HR3MZn2jvYaJbIkFZV/erWWwNaBU55MuhJswE4dYlcLX7vjUBeCb6YNGArVQQ+
	Sc0suUTZpLwSxR7uSJK4BeB9+2z3uBqFw7BhRekSs9PgHssYegQn+OZm4j/bGGbVCx9aqC
	HDWUqk5vy7FuSWHbd7L+vK4cD7jmPyIiCcqxPMm+a9UKUt1n+/fEWnGSP+6zrVSdfD2K7d
	Yg8nStKg0/rQzVup9zMup/aGQC3gWl6hj3sYB+UIkJALyp3vuGb+O8kajmf3wnpzwcJOMw
	OWtnT+E39b28KqmGzP0UdkjlLEJe/caA3GOmUD0rCOh8J26MyW9A6j8fFFcEVw==
Date: Fri, 14 Mar 2025 17:30:00 +0100
Precedence: bulk
X-Mailing-List: linux-kernel-mentees@lists.linux.dev
List-Id: <linux-kernel-mentees.lists.linux.dev>
List-Subscribe: <mailto:linux-kernel-mentees+subscribe@lists.linux.dev>
List-Unsubscribe: <mailto:linux-kernel-mentees+unsubscribe@lists.linux.dev>
MIME-Version: 1.0
Subject: Re: [PATCH] Documentation: kcsan: fix "Plain Accesses and Data Races"
 URL in kcsan.rst
To: Jonathan Corbet <corbet@lwn.net>, linux-kernel-mentees@lists.linux.dev,
 skhan@linuxfoundation.org, Marco Elver <elver@google.com>,
 Dmitry Vyukov <dvyukov@google.com>
Cc: kasan-dev@googlegroups.com, workflows@vger.kernel.org,
 linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
References: <20250306-fix-plain-access-url-v1-1-9c653800f9e0@iencinas.com>
 <87o6y5lvvg.fsf@trenco.lwn.net>
Content-Language: en-US
X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers.
From: Ignacio Encinas Rubio <ignacio@iencinas.com>
Autocrypt: addr=ignacio@iencinas.com; keydata=
 xjMEZgaZEBYJKwYBBAHaRw8BAQdAYZxeXU5yoeLYkQpvN+eE3wmAF4V0JUzIlpm/DqiSeBnN
 LElnbmFjaW8gRW5jaW5hcyBSdWJpbyA8aWduYWNpb0BpZW5jaW5hcy5jb20+wo8EExYIADcW
 IQSXV5vKYfM26lUMmYnH3J3Ka8TsNgUCZgaZEAUJBaOagAIbAwQLCQgHBRUICQoLBRYCAwEA
 AAoJEMfcncprxOw21F4BAJe+mYh3sIdSvydyDdDXLFqtVkzrFB8PVNSU9eZpvM0mAP9996LA
 N0gyY7Obnc3y59r9jOElOn/5fz5mOEU3nE5lCc44BGYGmRESCisGAQQBl1UBBQEBB0CVC5o6
 qnsTzmmtKY1UWa/GJE53dV/3UPJpZu42p/F0OAMBCAfCfgQYFggAJhYhBJdXm8ph8zbqVQyZ
 icfcncprxOw2BQJmBpkRBQkFo5qAAhsMAAoJEMfcncprxOw2N8ABAPcrkHouJPn2N8HcsL4S
 SVgqxNLVOpsMX9kAYgIMqM0WAQCA40v0iYH1q7QHa2IfgkrBzX2ZLdXdwoxfUr8EY5vtAg==
In-Reply-To: <87o6y5lvvg.fsf@trenco.lwn.net>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
X-Migadu-Flow: FLOW_OUT

On 12/3/25 23:36, Jonathan Corbet wrote:
> It would be best, of course, to get the memory-model documentation
> properly into our built docs...someday...

I hadn't thought about this. If this sentiment is shared by the LKMM
people I would be happy to work on this. Has this ever been
proposed/discussed before?

From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from mail-pl1-f174.google.com (mail-pl1-f174.google.com [209.85.214.174])
	(using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id 72B0018B484
	for <linux-kernel-mentees@lists.linux.dev>; Sat, 15 Mar 2025 02:41:08 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.174
ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1742006469; cv=none; b=PwQD0j0Y+siT9VYi2GDNq74UBfsrOkw08psYjonBJyOy5gjo7GBVId94f/Fp867CSxE35TL6t6mEKyI4eSXjbO6mThvJlrSHViq8ikf/cuiTLrV3EH+SRgC7GsruqL+nAdQtpyjsZve9pIJzwh1ivqw9U2F3UVoaNPlA77RbDLc=
ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1742006469; c=relaxed/simple;
	bh=B2CEDEhFdSbK5+6Qq7Xbe3jgxhR1ZYSO6nxrloEY2NU=;
	h=Message-ID:Date:MIME-Version:To:Cc:References:Subject:From:
	 In-Reply-To:Content-Type; b=K3sJUDypPrCxKzA63DsU2zD30PdDhOKOORd/fuDtm/yDKB86/Xq75EMz+h87uORj9ZMaGZifJ8gcK/v9X6ktNdKUaHsf9G9h24Khbe8rqHalvYpnhCezUUG56QaBUc4/sGL4uO3JlFzZylLAoallG4ebpcl0CKIUtq04//Ot2D8=
ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=lPnvYgZp; arc=none smtp.client-ip=209.85.214.174
Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com
Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="lPnvYgZp"
Received: by mail-pl1-f174.google.com with SMTP id d9443c01a7336-219f8263ae0so46795435ad.0
        for <linux-kernel-mentees@lists.linux.dev>; Fri, 14 Mar 2025 19:41:08 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
        d=gmail.com; s=20230601; t=1742006468; x=1742611268; darn=lists.linux.dev;
        h=content-transfer-encoding:in-reply-to:from:content-language:subject
         :references:cc:to:user-agent:mime-version:date:message-id:from:to:cc
         :subject:date:message-id:reply-to;
        bh=15gdaJdchlrAww0ZPYIU2PXFNpF4h7zH7gWYODgucLk=;
        b=lPnvYgZpunUcXd7AZWopSnzuG7qM3Aht55lDrn9mgNI2k4QwvbYBWpg1wM1OyihOZI
         Fl2X0Q8epj6s6D4APPsnKJnGwk1yD7evdKPWxlnJHgvZD61mZunIzMB+LycVFR28uYNx
         AJPzATn0sE1CnhDeeLtbzgcypcN374peiqNuBtH2HhjDxGXj04v8kAb7AIrpkQSbCCLk
         P47tnA0G6cUpF0OvfD3644ywSujXctLEMWa1Hd3F++cUej74hGQg2VuHc76nswQuPOC/
         tjlYa09X4N8BLTob9J+CvRbIDxrH2kv86ZKfWSxFBrBHNY+dD3hGuWRx083sRcvgkUvB
         Cykw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
        d=1e100.net; s=20230601; t=1742006468; x=1742611268;
        h=content-transfer-encoding:in-reply-to:from:content-language:subject
         :references:cc:to:user-agent:mime-version:date:message-id
         :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to;
        bh=15gdaJdchlrAww0ZPYIU2PXFNpF4h7zH7gWYODgucLk=;
        b=oh2XqVki0GQKHK2IoHaGJeMFWZ0eh3P6UztVPHd6BOtlLmJ3iJ/UFHjXMFeZ0IsOhc
         uLHeyd7axpu/pBVNbq6s4LC+Aa6A3GG0zYvd3wuzQD65onKsvT5FeT7McmdWuIUtUrK9
         ZDkznPchGGPy0nsvChd9YrofAAE0WzzZO4Vrsw6WC537oEoHho+UdTa/CTN1SNwfeUw/
         ZwFGgRNzlDotfUnBis0mp4UKnrqXOzzULEcKxU6mNm7hUowgJJDSZsvNpwsE73VHapOs
         9UaP3xwcBaT4NskPNtYXwzcENOnve5gjR8MeBINlv/4kWGjQ4prbmO1TPpOOkhaavg3a
         uAZg==
X-Forwarded-Encrypted: i=1; AJvYcCWUq7qZO3yVNc5dutiEHVBo0f1EtonAX458hpsW+Y5g1aZddF/WTUh2udrVvcyIW01gUlu5Knqggbf1HMFRBuMX/1pjqw==@lists.linux.dev
X-Gm-Message-State: AOJu0YzcwJF+2nzep+TxDhdkjAx9dBOw77vzDTgduPRk9s90ZZpkZ8bd
	t3gNXxsqDEZZZ2DcqruaeZPCftPr9RYTMPmAeS4LPr9eKF7pgR42
X-Gm-Gg: ASbGncvL0IFCjtv8cMzM4uYwKlOHrU5tDwaWuSsK88g9qlMjIIKe+5fw9AU67bjHm78
	RAqHm1VMCj6gDi2GBjImlhxMMd24kir31mwwb5WQbTtGTlVAuM1k+GAc0VVFw6usemfjcNJW+MB
	6hZ+im5u9eWgs/fnXhRqn6yC006q5ucPP/12ytqetNt0HAm/PmHUKYoS1PkIDar9vy0hOqs4Mm6
	ZJgHlHRjWgV8rtuqSAup37O+gfLH4nWUmhTI3WquTxaCNOg8aqD3GTJx7V2WRQoC4YMYrLt3Uyc
	VIv/fu/O2tliA3VWpnH/u5xRtFpFoT9+i7vU6/RYDq58CFVBx5ZBjo+5vNFlb/80mwVUL0ygUcW
	HbWUd7tPhp/9Syjk=
X-Google-Smtp-Source: AGHT+IFaFRZP4GF2msqauqXMGAobEitpbtIOLAfjlGUx0Lcd1m68pCYkXYMSC7iLEn+TyVaHIjArSA==
X-Received: by 2002:a17:903:2b0f:b0:223:49cb:5eaa with SMTP id d9443c01a7336-225e0aeeaadmr76664625ad.35.1742006467666;
        Fri, 14 Mar 2025 19:41:07 -0700 (PDT)
Received: from [10.0.2.15] (KD106167137155.ppp-bb.dion.ne.jp. [106.167.137.155])
        by smtp.gmail.com with ESMTPSA id d9443c01a7336-225c6ba740bsm35410785ad.122.2025.03.14.19.41.04
        (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128);
        Fri, 14 Mar 2025 19:41:07 -0700 (PDT)
Message-ID: <c6a697af-281a-4a91-8885-a4478dfe2cef@gmail.com>
Date: Sat, 15 Mar 2025 11:41:03 +0900
Precedence: bulk
X-Mailing-List: linux-kernel-mentees@lists.linux.dev
List-Id: <linux-kernel-mentees.lists.linux.dev>
List-Subscribe: <mailto:linux-kernel-mentees+subscribe@lists.linux.dev>
List-Unsubscribe: <mailto:linux-kernel-mentees+unsubscribe@lists.linux.dev>
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
To: ignacio@iencinas.com
Cc: corbet@lwn.net, dvyukov@google.com, elver@google.com,
 kasan-dev@googlegroups.com, linux-doc@vger.kernel.org,
 linux-kernel-mentees@lists.linux.dev, linux-kernel@vger.kernel.org,
 skhan@linuxfoundation.org, workflows@vger.kernel.org,
 Akira Yokosawa <akiyks@gmail.com>
References: <1d66a62e-faee-4604-9136-f90eddcfa7c0@iencinas.com>
Subject: Re: [PATCH] Documentation: kcsan: fix "Plain Accesses and Data Races"
 URL in kcsan.rst
Content-Language: en-US
From: Akira Yokosawa <akiyks@gmail.com>
In-Reply-To: <1d66a62e-faee-4604-9136-f90eddcfa7c0@iencinas.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit

Hello,

Ignacio Encinas Rubio wrote:
> On 12/3/25 23:36, Jonathan Corbet wrote:
>> It would be best, of course, to get the memory-model documentation
>> properly into our built docs...someday...
> 
> I hadn't thought about this. If this sentiment is shared by the LKMM
> people I would be happy to work on this. Has this ever been
> proposed/discussed before?
>

This might be something Jon would like to keep secret, but ...

See the message and the thread it belongs at:

    https://lore.kernel.org/lkml/Pine.LNX.4.44L0.1907310947340.1497-100000@iolanthe.rowland.org/

It happened in 2019 responding to Mauro's attempt to conversion of
LKMM docs.

I haven't see any change in sentiment among LKMM maintainers since.

Your way forward would be to keep those .txt files *pure plain text"
and to convert them on-the-fly into reST.  Of course only if such an
effort sounds worthwhile to you.

Another approach might be to include those docs literally.
Similar approach has applied to

    Documentation/
	atomic_t.txt
	atomic_bitops.txt
        memory-barriers.txt

Regards,
Akira


From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from out-183.mta0.migadu.com (out-183.mta0.migadu.com [91.218.175.183])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id 7FAAC1DF969
	for <linux-kernel-mentees@lists.linux.dev>; Sat, 15 Mar 2025 12:21:50 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=91.218.175.183
ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1742041313; cv=none; b=WpsncSnFjCZMWKBRdg2o4IHIxjzNTgabm2S1rcxYF2ZOv9d6RPOW/x9FO9vWfmHcb3Ci2o78jyi/AxAZo63GESpkf46N9n1XwRKCblpFFhrXDTPCnYeb7Io1YEA3AnTij2weDKrn/2EKztqbHtSwa74DZM8pYY9v0WuOqYXXnc0=
ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1742041313; c=relaxed/simple;
	bh=wy6c20spWXmcS2DWIuXkVaGyvR3S8hTMEupyMxN48h0=;
	h=Message-ID:Date:MIME-Version:Subject:To:Cc:References:From:
	 In-Reply-To:Content-Type; b=cjA8kjkGbXWlj3FGnTCokbF2k4TcTZq8huWTZ5Hg8Pmg4OqWT49KI8JIt3P+MxNoVVsEG9buDCR3FGyTZWepXMXspyp1qsEA63XzfDiVq59zfn353EgaGcpSkeaIze+JPObhb/57eDWTfoWmxH1OuMtTq2+7IBLXZJC3z0kXPqQ=
ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=iencinas.com; spf=pass smtp.mailfrom=iencinas.com; dkim=pass (2048-bit key) header.d=iencinas.com header.i=@iencinas.com header.b=lcEMBs7h; arc=none smtp.client-ip=91.218.175.183
Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=iencinas.com
Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=iencinas.com
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=iencinas.com header.i=@iencinas.com header.b="lcEMBs7h"
Message-ID: <9c6298a2-4efa-4f77-81c0-b2132f48c1b0@iencinas.com>
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iencinas.com;
	s=key1; t=1742041308;
	h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
	 to:to:cc:cc:mime-version:mime-version:content-type:content-type:
	 content-transfer-encoding:content-transfer-encoding:
	 in-reply-to:in-reply-to:references:references;
	bh=4pHhzfXW24TF1t1FOgMUb4yg/TvgoSuq5by1lc39Sis=;
	b=lcEMBs7hDHnSc0+QfxLmeZDIERK/dJY68x+llhQSLKp9G00S01R84WKw83XJyuvTMYeLMB
	8DF9YfNP5+MXAwlcgypmjk+GSuo93jaqX21XnnJ5xxx00ldRX8dqrFfwQK9NM0DJM2m0Mj
	DeygCKkWiBcK7/TouZY26iJWUm139hA1mbL9gi4YCxjIw4W0pz7kaE09y+KhAMebA1qPli
	2IWYBaEHlNcZBkuFC53V0susnEgNklY23VZgOffvT+FXiLUGSZfp+WIJhesX2iBbGCEPcH
	OlutoqHPbk9V0BZZtlNBrNLpKkywoHqByp09B6sMGS2jY7PU2iVNl63jS1ZLtg==
Date: Sat, 15 Mar 2025 13:21:43 +0100
Precedence: bulk
X-Mailing-List: linux-kernel-mentees@lists.linux.dev
List-Id: <linux-kernel-mentees.lists.linux.dev>
List-Subscribe: <mailto:linux-kernel-mentees+subscribe@lists.linux.dev>
List-Unsubscribe: <mailto:linux-kernel-mentees+unsubscribe@lists.linux.dev>
MIME-Version: 1.0
Subject: Re: [PATCH] Documentation: kcsan: fix "Plain Accesses and Data Races"
 URL in kcsan.rst
To: Akira Yokosawa <akiyks@gmail.com>
Cc: corbet@lwn.net, dvyukov@google.com, elver@google.com,
 kasan-dev@googlegroups.com, linux-doc@vger.kernel.org,
 linux-kernel-mentees@lists.linux.dev, linux-kernel@vger.kernel.org,
 skhan@linuxfoundation.org, workflows@vger.kernel.org
References: <1d66a62e-faee-4604-9136-f90eddcfa7c0@iencinas.com>
 <c6a697af-281a-4a91-8885-a4478dfe2cef@gmail.com>
Content-Language: en-US
X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers.
From: Ignacio Encinas Rubio <ignacio@iencinas.com>
In-Reply-To: <c6a697af-281a-4a91-8885-a4478dfe2cef@gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
X-Migadu-Flow: FLOW_OUT

On 15/3/25 3:41, Akira Yokosawa wrote:
> This might be something Jon would like to keep secret, but ...
> 
> See the message and the thread it belongs at:
> 
>     https://lore.kernel.org/lkml/Pine.LNX.4.44L0.1907310947340.1497-100000@iolanthe.rowland.org/
> 
> It happened in 2019 responding to Mauro's attempt to conversion of
> LKMM docs.
> 
> I haven't see any change in sentiment among LKMM maintainers since.

Thanks for the information!

> Your way forward would be to keep those .txt files *pure plain text"
> and to convert them on-the-fly into reST.  Of course only if such an
> effort sounds worthwhile to you.

With this you mean producing a .rst from the original .txt file using an 
script before building the documentation, right? I'm not sure how hard 
this is, but I can look into it.

> Another approach might be to include those docs literally.
> Similar approach has applied to
> 
>     Documentation/
> 	atomic_t.txt
> 	atomic_bitops.txt
>         memory-barriers.txt

Right, I got to [1]. 

It looks like there are several options here:

  A) Include the text files like in [1]
  B) Explore the "on-the-fly" translation
  C) Do A) and then B)

Does any of the above sound good, Jon?

Thank you both for your time

[1] https://lore.kernel.org/all/20220927160559.97154-7-corbet@lwn.net/

From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from ms.lwn.net (ms.lwn.net [45.79.88.28])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by smtp.subspace.kernel.org (Postfix) with ESMTPS id 503D518C33B
	for <linux-kernel-mentees@lists.linux.dev>; Mon, 17 Mar 2025 23:03:30 +0000 (UTC)
Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=45.79.88.28
ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;
	t=1742252611; cv=none; b=uzm18Eg/nhnDWU7vTh0uMEp5+GlAhGIMl46v8Cl2L5lMd7NnY28TJndZXCZUx49gp7ExYGtio3lFAh7a0bAQbbV5hxDcTtTDdmE4w/NWqMbeyngsk3RiK2q1At0OrBFhS8Xz3oarIi1Pip9cqSLJ8dAvPPq7XW4Db558uMhkDdo=
ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org;
	s=arc-20240116; t=1742252611; c=relaxed/simple;
	bh=h3reA+aWlA6dgBfBWlL0U5BYECup4bVKgKKBy4OkOLY=;
	h=From:To:Cc:Subject:In-Reply-To:References:Date:Message-ID:
	 MIME-Version:Content-Type; b=GvYaymPj/q9cb7QmJLxfvN4MuZzhw5ntRb0mv4sKRgkiO3vAhUYV18OlUnlZQFe2CtsTO5f9mt3U8pu/W0po322uAxOeVVvdYEHkJWemZ7LjdNaHt+2J0mp2sz/3W0f0bXDVXxIhfX3U4+6VpsE9JF5mFmZ6GZv6OhTxVRStZ6c=
ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net; spf=pass smtp.mailfrom=lwn.net; dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b=o66rMn0y; arc=none smtp.client-ip=45.79.88.28
Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net
Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=lwn.net
Authentication-Results: smtp.subspace.kernel.org;
	dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b="o66rMn0y"
DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 331DF41061
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203;
	t=1742252609; bh=Bn+dVkNzGPe0Z7ovmJwNwQJS6CVQZAD2/ACJeTPZJbc=;
	h=From:To:Cc:Subject:In-Reply-To:References:Date:From;
	b=o66rMn0yPNUuvIyQSiQf7ptnYAMzEdFN7OsleDrB2CQagQTgTljykJk2FfhjD/LQ9
	 UgSKjgC4POLxWyEHB6PWok4M/IZxbqATub5bXDMkk12CZgnFrKoExgCxD2Sr69hjl3
	 PY0ROqle6kFVnuU3rCHDlN/tK/y1wis0hy6oe2IYZqWE7/ovoovOFWU7OtsX5KYS67
	 qq28oM9VCprG39gqqPHXENOUU+S8wi//2PMnVMO+R/fYGrNpe8kmEwdrqoL9+qpABd
	 dBqlYuMBqAQ+Le355hqT6ACIr7yrV5WP2/+1j8wkV/GV1V0xVjtcRi4wF6UdGVBX7q
	 Xf3mFqY6fxW8A==
Received: from localhost (unknown [IPv6:2601:280:4600:2da9::1fe])
	(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
	 key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256)
	(No client certificate requested)
	by ms.lwn.net (Postfix) with ESMTPSA id 331DF41061;
	Mon, 17 Mar 2025 23:03:29 +0000 (UTC)
From: Jonathan Corbet <corbet@lwn.net>
To: Ignacio Encinas Rubio <ignacio@iencinas.com>, Akira Yokosawa
 <akiyks@gmail.com>
Cc: dvyukov@google.com, elver@google.com, kasan-dev@googlegroups.com,
 linux-doc@vger.kernel.org, linux-kernel-mentees@lists.linux.dev,
 linux-kernel@vger.kernel.org, skhan@linuxfoundation.org,
 workflows@vger.kernel.org
Subject: Re: [PATCH] Documentation: kcsan: fix "Plain Accesses and Data
 Races" URL in kcsan.rst
In-Reply-To: <9c6298a2-4efa-4f77-81c0-b2132f48c1b0@iencinas.com>
References: <1d66a62e-faee-4604-9136-f90eddcfa7c0@iencinas.com>
 <c6a697af-281a-4a91-8885-a4478dfe2cef@gmail.com>
 <9c6298a2-4efa-4f77-81c0-b2132f48c1b0@iencinas.com>
Date: Mon, 17 Mar 2025 17:03:28 -0600
Message-ID: <87zfhjcla7.fsf@trenco.lwn.net>
Precedence: bulk
X-Mailing-List: linux-kernel-mentees@lists.linux.dev
List-Id: <linux-kernel-mentees.lists.linux.dev>
List-Subscribe: <mailto:linux-kernel-mentees+subscribe@lists.linux.dev>
List-Unsubscribe: <mailto:linux-kernel-mentees+unsubscribe@lists.linux.dev>
MIME-Version: 1.0
Content-Type: text/plain

Ignacio Encinas Rubio <ignacio@iencinas.com> writes:

> On 15/3/25 3:41, Akira Yokosawa wrote:
>> This might be something Jon would like to keep secret, but ...
>> 
>> See the message and the thread it belongs at:
>> 
>>     https://lore.kernel.org/lkml/Pine.LNX.4.44L0.1907310947340.1497-100000@iolanthe.rowland.org/
>> 
>> It happened in 2019 responding to Mauro's attempt to conversion of
>> LKMM docs.
>> 
>> I haven't see any change in sentiment among LKMM maintainers since.
>
> Thanks for the information!

FWIW, I don't think it has really been discussed since.

>> Your way forward would be to keep those .txt files *pure plain text"
>> and to convert them on-the-fly into reST.  Of course only if such an
>> effort sounds worthwhile to you.
>
> With this you mean producing a .rst from the original .txt file using an 
> script before building the documentation, right? I'm not sure how hard 
> this is, but I can look into it.
>
>> Another approach might be to include those docs literally.
>> Similar approach has applied to
>> 
>>     Documentation/
>> 	atomic_t.txt
>> 	atomic_bitops.txt
>>         memory-barriers.txt
>
> Right, I got to [1]. 
>
> It looks like there are several options here:
>
>   A) Include the text files like in [1]
>   B) Explore the "on-the-fly" translation
>   C) Do A) and then B)
>
> Does any of the above sound good, Jon?

Using the wrapper technique will surely work and should be an
improvement over what we have now.  I don't hold out much hope for "on
the fly" mangling of the text - it sounds brittle and never quite good
enough, but I'm willing to be proved wrong on that front.

The original discussion from all those years ago centered around worries
about inserting lots of markup into the plain-text file.  But I'm not
convinced that anything requires all that markup; indeed, the proposed
conversion at the time didn't do that.  The question was quickly dropped
because we had so much to do back then...

I think there might be value in trying another minimal-markup
conversion; it would be *nicer* to use more fonts in the HTML version,
but not doing so seems better than not having an HTML version at all.
But, obviously, there are no guarantees that it will clear the bar.

Thanks,

jon

