linux-kernel - Re: [PATCH 1/3] Documentation: seqlock: Add a reference label and license.

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <87ikjth5nc.fsf@trenco.lwn.net>
Date: Tue, 15 Jul 2025 08:48:07 -0600
From: Jonathan Corbet <corbet@....net>
To: Sebastian Andrzej Siewior <bigeasy@...utronix.de>,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 linux-rt-devel@...ts.linux.dev
Cc: Boqun Feng <boqun.feng@...il.com>, Clark Williams
 <clrkwllms@...nel.org>, Frederic Weisbecker <frederic@...nel.org>, Ingo
 Molnar <mingo@...hat.com>, John Ogness <john.ogness@...utronix.de>, Peter
 Zijlstra <peterz@...radead.org>, Steven Rostedt <rostedt@...dmis.org>,
 Thomas Gleixner <tglx@...utronix.de>, Valentin Schneider
 <vschneid@...hat.com>, Waiman Long <longman@...hat.com>, Will Deacon
 <will@...nel.org>, Sebastian Andrzej Siewior <bigeasy@...utronix.de>,
 "Ahmed S. Darwish" <darwi@...utronix.de>
Subject: Re: [PATCH 1/3] Documentation: seqlock: Add a reference label and
 license.

Sebastian Andrzej Siewior <bigeasy@...utronix.de> writes:

> Add a reference label to the document so it can be crossed referenced
> from another document in the tree.
> While at it, add a SPDX identifier. The majority of the document has
> been written Ahmed S. Darwish.
>
> Cc: Ahmed S. Darwish <darwi@...utronix.de>
> Signed-off-by: Sebastian Andrzej Siewior <bigeasy@...utronix.de>
> ---
>  Documentation/locking/seqlock.rst | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/Documentation/locking/seqlock.rst b/Documentation/locking/seqlock.rst
> index ec6411d02ac8f..4936b46dedc59 100644
> --- a/Documentation/locking/seqlock.rst
> +++ b/Documentation/locking/seqlock.rst
> @@ -1,3 +1,7 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +.. _kernel_hacking_seqlock:
> +

This will work, but you don't really need the label.  Just say
"Documentation/locking/seqlock.rst" at the other end and the
cross-reference link will happen by itself - and plain-text readers will
know where to go as well.

Thanks,

jon