Re: checkpatch doc suggestion

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, Apr 30, 2024 at 12:56:30PM +0200, Diederik de Haas wrote:
> Hi,
> 
> I think it would be really useful if (f.e.) the following URL
> https://docs.kernel.org/dev-tools/checkpatch.html#BAD_FIXES_TAG
> 
> would lead me straight to the BAD_FIXES_TAG explanation.

So to add link to arbitrary location in the docs, you have to explicitly add
target (anchor) to desired location. Then you can reference it using the
target's name. For example, to accomplish your suggestion above:

```
diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index 12796899584739..002b0aa68b8022 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -612,6 +612,8 @@ Commit message
 
     See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
 
+.. _bad_fixes_tag:
+
   **BAD_FIXES_TAG**
     The Fixes: tag is malformed or does not follow the community conventions.
     This can occur if the tag have been split into multiple lines (e.g., when
@@ -1254,3 +1256,4 @@ Others
 
   **TYPO_SPELLING**
     Some words may have been misspelled.  Consider reviewing them.
+    But have you :ref:`check this? <bad_fixes_tag>`

```

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux