From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Diederik de Haas <didi.debian@cknow.org>,
Linux Documentation <linux-doc@vger.kernel.org>
Subject: Re: checkpatch doc suggestion
Date: Fri, 3 May 2024 19:55:49 +0700 [thread overview]
Message-ID: <ZjTe1STECXg2mmmJ@archie.me> (raw)
In-Reply-To: <8090211.0vHzs8tI1a@bagend>
[-- Attachment #1: Type: text/plain, Size: 1342 bytes --]
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 #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
next prev parent reply other threads:[~2024-05-03 12:55 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-30 10:56 checkpatch doc suggestion Diederik de Haas
2024-05-03 12:55 ` Bagas Sanjaya [this message]
2024-05-06 13:59 ` Diederik de Haas
2024-05-08 0:16 ` Bagas Sanjaya
2024-05-12 15:58 ` Diederik de Haas
2024-05-13 5:08 ` Akira Yokosawa
2024-05-13 9:53 ` Diederik de Haas
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ZjTe1STECXg2mmmJ@archie.me \
--to=bagasdotme@gmail.com \
--cc=didi.debian@cknow.org \
--cc=linux-doc@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).