Documentation: w1: Fix SPDX comment syntax on masters and slaves toctree index

[PATCH] Documentation: w1: Fix SPDX comment syntax on masters and slaves toctree index

Posted by Bagas Sanjaya 3 weeks, 2 days ago

Commit e9bb627561535d ("docs: w1: convert to ReST and add to the kAPI
group of docs") converts 1-Wire docs to reST alongside with SPDX
comment, yet the comment is written in one dot as opposed to two in
order to be recognized as comment directive, which spills it into
htmldocs output. This issue is partially fixed in d8fb03e1ea64e7 ("docs:
w1: Fix SPDX-License-Identifier syntax") as it only touches top-level w1
toctree.

Do the same fix on masters and slaves toctrees.

Fixes: e9bb62756153 ("docs: w1: convert to ReST and add to the kAPI group of docs")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/w1/masters/index.rst | 2 +-
 Documentation/w1/slaves/index.rst  | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/w1/masters/index.rst b/Documentation/w1/masters/index.rst
index cc40189909fd17..871442c7f195bf 100644
--- a/Documentation/w1/masters/index.rst
+++ b/Documentation/w1/masters/index.rst
@@ -1,4 +1,4 @@
-. SPDX-License-Identifier: GPL-2.0
+.. SPDX-License-Identifier: GPL-2.0
 
 =====================
 1-wire Master Drivers
diff --git a/Documentation/w1/slaves/index.rst b/Documentation/w1/slaves/index.rst
index d0697b202f09f0..a210f38c889c14 100644
--- a/Documentation/w1/slaves/index.rst
+++ b/Documentation/w1/slaves/index.rst
@@ -1,4 +1,4 @@
-. SPDX-License-Identifier: GPL-2.0
+.. SPDX-License-Identifier: GPL-2.0
 
 ====================
 1-wire Slave Drivers

base-commit: 7e5a0fe4e8ae2eb341f8ebbee2b24231a58fc28b
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] Documentation: w1: Fix SPDX comment syntax on masters and slaves toctree index

Posted by Jonathan Corbet 3 weeks, 2 days ago

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Commit e9bb627561535d ("docs: w1: convert to ReST and add to the kAPI
> group of docs") converts 1-Wire docs to reST alongside with SPDX
> comment, yet the comment is written in one dot as opposed to two in
> order to be recognized as comment directive, which spills it into
> htmldocs output. This issue is partially fixed in d8fb03e1ea64e7 ("docs:
> w1: Fix SPDX-License-Identifier syntax") as it only touches top-level w1
> toctree.
>
> Do the same fix on masters and slaves toctrees.
>
> Fixes: e9bb62756153 ("docs: w1: convert to ReST and add to the kAPI group of docs")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/w1/masters/index.rst | 2 +-
>  Documentation/w1/slaves/index.rst  | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)

Applied, thanks.

jon

Re: [PATCH] Documentation: w1: Fix SPDX comment syntax on masters and slaves toctree index

Posted by Krzysztof Kozlowski 3 weeks, 2 days ago

On 09/09/2025 04:21, Bagas Sanjaya wrote:
> Commit e9bb627561535d ("docs: w1: convert to ReST and add to the kAPI
> group of docs") converts 1-Wire docs to reST alongside with SPDX
> comment, yet the comment is written in one dot as opposed to two in
> order to be recognized as comment directive, which spills it into
> htmldocs output. This issue is partially fixed in d8fb03e1ea64e7 ("docs:
> w1: Fix SPDX-License-Identifier syntax") as it only touches top-level w1
> toctree.
> 
> Do the same fix on masters and slaves toctrees.
> 
> Fixes: e9bb62756153 ("docs: w1: convert to ReST and add to the kAPI group of docs")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

I guess that's the patch for docs (not w1) tree.

Best regards,
Krzysztof