Skip to contentSkip to conversation

docs: kprobes: Update URLs and move under trace/

PATCH Applied Naveen N. Rao 3 participants 6 messages Jul 21, 2020 – Jul 23, 2020

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

cover docs: kprobes: Update URLs and move under trace/

This series updates some of the URLs in the kprobes document and moves the same under trace/ directory.

- Naveen

Naveen N. Rao (3):
docs: staging/kprobes.rst: Update some of the references
docs: staging/kprobes.rst: Move references to a separate appendix
docs: Move kprobes.rst from staging/ to trace/

 Documentation/staging/index.rst              |  1 -
 Documentation/trace/index.rst                |  1 +
 Documentation/{staging => trace}/kprobes.rst | 16 +++++++++-------
 3 files changed, 10 insertions(+), 8 deletions(-)
 rename Documentation/{staging => trace}/kprobes.rst (99%)

base-commit: f33d4075e512274c0c6edcd7602da2cf1d5a0341

Signature · 1 line
2.25.4
#1 lore raw

PATCH 1/3 docs: staging/kprobes.rst: Update some of the references

Some of the kprobes references are not valid anymore. Update the URLs to point to their changed locations, where appropriate. Drop two URLs which do not exist anymore.

---
 Documentation/staging/kprobes.rst | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)
Documentation/staging/kprobes.rst +2 -4
index 8baab8832c5b..620699f5df22 100644
@@ -712,10 +712,8 @@ See samples/kprobes/kretprobe_example.c
 
 For additional information on Kprobes, refer to the following URLs:
 
-- http://www-106.ibm.com/developerworks/library/l-kprobes.html?ca=dgr-lnxw42Kprobe
-- http://www.redhat.com/magazine/005mar05/features/kprobes/
-- http://www-users.cs.umn.edu/~boutcher/kprobes/
-- http://www.linuxsymposium.org/2006/linuxsymposium_procv2.pdf (pages 101-115)
+- https://www.ibm.com/developerworks/library/l-kprobes/index.html
+- https://www.kernel.org/doc/ols/2006/ols2006v2-pages-109-124.pdf
 
 Deprecated Features
 ===================
Signature · 1 line
2.25.4
#2 lore raw

PATCH 2/3 docs: staging/kprobes.rst: Move references to a separate appendix

In reply to Naveen N. Rao

Kprobes references are currently listed right after kretprobes example, and appears to be part of the same section. Move this out to a separate appendix for clarity.

---
 Documentation/staging/kprobes.rst | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)
Documentation/staging/kprobes.rst +9 -5
index 620699f5df22..b757b6dfd3d4 100644
@@ -20,6 +20,7 @@ Kernel Probes (Kprobes)
   10. Deprecated Features
   Appendix A: The kprobes debugfs interface
   Appendix B: The kprobes sysctl interface
+  Appendix C: References
 
 Concepts: Kprobes and Return Probes
 =========================================
@@ -710,11 +711,6 @@ Kretprobes Example
 
 See samples/kprobes/kretprobe_example.c
 
-For additional information on Kprobes, refer to the following URLs:
-
-- https://www.ibm.com/developerworks/library/l-kprobes/index.html
-- https://www.kernel.org/doc/ols/2006/ols2006v2-pages-109-124.pdf
-
 Deprecated Features
 ===================
 
@@ -797,3 +793,11 @@ Note that this knob *changes* the optimized state. This means that optimized
 probes (marked [OPTIMIZED]) will be unoptimized ([OPTIMIZED] tag will be
 removed). If the knob is turned on, they will be optimized again.
 
+References
+==========
+
+For additional information on Kprobes, refer to the following URLs:
+
+- https://www.ibm.com/developerworks/library/l-kprobes/index.html
+- https://www.kernel.org/doc/ols/2006/ols2006v2-pages-109-124.pdf
+
Signature · 1 line
2.25.4
#3 lore raw

PATCH 3/3 docs: Move kprobes.rst from staging/ to trace/

In reply to Naveen N. Rao

Kprobes contitutes a dynamic tracing technology and as such can be moved alongside documentation of other tracing technologies.

---
 Documentation/staging/index.rst              | 1 -
 Documentation/trace/index.rst                | 1 +
 Documentation/{staging => trace}/kprobes.rst | 0
 3 files changed, 1 insertion(+), 1 deletion(-)
 rename Documentation/{staging => trace}/kprobes.rst (100%)
Documentation/staging/index.rst +0 -1
index 184e6aece0a7..abd0d18254d2 100644
@@ -7,7 +7,6 @@ Unsorted Documentation
    :maxdepth: 2
 
    crc32
-   kprobes
    lzo
    remoteproc
    rpmsg
Documentation/trace/index.rst +1 -0
index 7d83156c9ac1..879ebb9f647d 100644
@@ -9,6 +9,7 @@ Linux Tracing Technologies
    tracepoint-analysis
    ftrace
    ftrace-uses
+   kprobes
    kprobetrace
    uprobetracer
    tracepoints
Documentation/trace/kprobes.rst renamed from Documentation/staging/kprobes.rst +0 -0
similarity index 100%
rename from Documentation/staging/kprobes.rst
rename to Documentation/trace/kprobes.rst
Signature · 1 line
2.25.4
maintainer Acked-by on the v1 series
#4 lore raw
In reply to Naveen N. Rao

Hi Naveen,

Quoted 2 lines · On Tue, 21 Jul 2020 17:18:19 +0530 "Naveen N. Rao"…

This series updates some of the URLs in the kprobes document and moves the same under trace/ directory.

Thank you very much for fixing and updating it!

for this series.

Thanks!

Quoted 20 lines

- Naveen

Naveen N. Rao (3):
docs: staging/kprobes.rst: Update some of the references
docs: staging/kprobes.rst: Move references to a separate appendix
docs: Move kprobes.rst from staging/ to trace/

 Documentation/staging/index.rst              |  1 -
 Documentation/trace/index.rst                |  1 +
 Documentation/{staging => trace}/kprobes.rst | 16 +++++++++-------
 3 files changed, 10 insertions(+), 8 deletions(-)
 rename Documentation/{staging => trace}/kprobes.rst (99%)

base-commit: f33d4075e512274c0c6edcd7602da2cf1d5a0341

Signature · 1 line
2.25.4
Signature · 1 line
Masami Hiramatsu <[email protected]>
maintainer Applied
#5 lore raw
In reply to Naveen N. Rao
Quoted 11 lines · On Tue, 21 Jul 2020 17:18:19 +0530 "Naveen N. Rao"…

This series updates some of the URLs in the kprobes document and moves the same under trace/ directory.

- Naveen

Naveen N. Rao (3):
docs: staging/kprobes.rst: Update some of the references
docs: staging/kprobes.rst: Move references to a separate appendix
docs: Move kprobes.rst from staging/ to trace/

Quoted 5 lines
 Documentation/staging/index.rst              |  1 -
 Documentation/trace/index.rst                |  1 +
 Documentation/{staging => trace}/kprobes.rst | 16 +++++++++-------
 3 files changed, 10 insertions(+), 8 deletions(-)
 rename Documentation/{staging => trace}/kprobes.rst (99%)

I've applied the set, thanks.

jon