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

Sebastian Andrzej Siewior posted 3 patches 2 months, 3 weeks ago
There is a newer version of this series
[PATCH 1/3] Documentation: seqlock: Add a reference label and license.
Posted by Sebastian Andrzej Siewior 2 months, 3 weeks ago
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@linutronix.de>
Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.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:
+
 ======================================
 Sequence counters and sequential locks
 ======================================
-- 
2.50.0
Re: [PATCH 1/3] Documentation: seqlock: Add a reference label and license.
Posted by Jonathan Corbet 2 months, 3 weeks ago
Sebastian Andrzej Siewior <bigeasy@linutronix.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@linutronix.de>
> Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.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
Re: [PATCH 1/3] Documentation: seqlock: Add a reference label and license.
Posted by Sebastian Andrzej Siewior 2 months, 3 weeks ago
On 2025-07-15 08:48:07 [-0600], Jonathan Corbet wrote:
> > --- 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.

I did
	 :ref:`Documentation/locking/seqlock.rst <kernel_hacking_seqlock>`

and you are saying just the file path without fancy :ref: is enough.
Okay. Then I keep just SPDX tag for v2.

> Thanks,
> 
> jon

Sebastian