[Linux-kernel-mentees] [PATCH] Documentation: RCU: lockdep.txt: Convert to lockdep.rst

[Linux-kernel-mentees] [PATCH] Documentation: RCU: lockdep.txt: Convert to lockdep.rst

[Pawan Kumar Meena]

This patch converts lockdep.txt to lockdep.rst and adds it to index.rst.

Signed-off-by: Pawan Kumar Meena <pawank1804@gmail.com>
---
 Documentation/RCU/index.rst                    | 1 +
 Documentation/RCU/{lockdep.txt => lockdep.rst} | 2 ++
 2 files changed, 3 insertions(+)
 rename Documentation/RCU/{lockdep.txt => lockdep.rst} (99%)

diff --git a/Documentation/RCU/index.rst b/Documentation/RCU/index.rst
index 81a0a1e5f767..109dea13f165 100644
--- a/Documentation/RCU/index.rst
+++ b/Documentation/RCU/index.rst
@@ -10,6 +10,7 @@ RCU concepts
    arrayRCU
    rcubarrier
    rcu_dereference
+   lockdep
    whatisRCU
    rcu
    listRCU
diff --git a/Documentation/RCU/lockdep.txt b/Documentation/RCU/lockdep.rst
similarity index 99%
rename from Documentation/RCU/lockdep.txt
rename to Documentation/RCU/lockdep.rst
index 89db949eeca0..4e71f77bdd28 100644
--- a/Documentation/RCU/lockdep.txt
+++ b/Documentation/RCU/lockdep.rst
@@ -1,3 +1,5 @@
+.. _lockdep_doc:
+
 RCU and lockdep checking
 
 All flavors of RCU have lockdep checking available, so that lockdep is
-- 
2.17.1

_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

Re: [Linux-kernel-mentees] [PATCH] Documentation: RCU: lockdep.txt: Convert to lockdep.rst

[Jonathan Corbet]

On Sun,  1 Mar 2020 01:16:36 +0530
Pawan Kumar Meena <pawank1804@gmail.com> wrote:

> diff --git a/Documentation/RCU/lockdep.txt b/Documentation/RCU/lockdep.rst
> similarity index 99%
> rename from Documentation/RCU/lockdep.txt
> rename to Documentation/RCU/lockdep.rst
> index 89db949eeca0..4e71f77bdd28 100644
> --- a/Documentation/RCU/lockdep.txt
> +++ b/Documentation/RCU/lockdep.rst
> @@ -1,3 +1,5 @@
> +.. _lockdep_doc:
> +
>  RCU and lockdep checking
>  
>  All flavors of RCU have lockdep checking available, so that lockdep is

So what about the rest of the file?  You've renamed it, but there's no
formatting changes to the document itself.

Also...  we don't add labels to code just because we might want to jump to
them someday.  Similarly, I don't think we should add labels to the docs
unless we actually need them.

Thanks,

jon
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

[Linux-kernel-mentees] [PATCH] Documentation: RCU: lockdep.txt: Convert to lockdep.rst

[Pawan Kumar Meena]

This patch converts lockdep.txt to lockdep.rst and adds it to index.rst.

Signed-off-by: Pawan Kumar Meena <pawank1804@gmail.com>
---
 Documentation/RCU/index.rst                    | 1 +
 Documentation/RCU/{lockdep.txt => lockdep.rst} | 2 ++
 2 files changed, 3 insertions(+)
 rename Documentation/RCU/{lockdep.txt => lockdep.rst} (99%)

diff --git a/Documentation/RCU/index.rst b/Documentation/RCU/index.rst
index 81a0a1e5f767..109dea13f165 100644
--- a/Documentation/RCU/index.rst
+++ b/Documentation/RCU/index.rst
@@ -10,6 +10,7 @@ RCU concepts
    arrayRCU
    rcubarrier
    rcu_dereference
+   lockdep
    whatisRCU
    rcu
    listRCU
diff --git a/Documentation/RCU/lockdep.txt b/Documentation/RCU/lockdep.rst
similarity index 99%
rename from Documentation/RCU/lockdep.txt
rename to Documentation/RCU/lockdep.rst
index 89db949eeca0..4e71f77bdd28 100644
--- a/Documentation/RCU/lockdep.txt
+++ b/Documentation/RCU/lockdep.rst
@@ -1,3 +1,5 @@
+.. _lockdep_doc:
+
 RCU and lockdep checking
 
 All flavors of RCU have lockdep checking available, so that lockdep is
-- 
2.17.1

_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees