Linux-Doc Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH 0/3] docs: kprobes: Update URLs and move under trace/
@ 2020-07-21 11:48 Naveen N. Rao
  2020-07-21 11:48 ` [PATCH 1/3] docs: staging/kprobes.rst: Update some of the references Naveen N. Rao
                   ` (4 more replies)
  0 siblings, 5 replies; 6+ messages in thread
From: Naveen N. Rao @ 2020-07-21 11:48 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: linux-doc, Masami Hiramatsu, linux-kernel

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
-- 
2.25.4


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH 1/3] docs: staging/kprobes.rst: Update some of the references
  2020-07-21 11:48 [PATCH 0/3] docs: kprobes: Update URLs and move under trace/ Naveen N. Rao
@ 2020-07-21 11:48 ` Naveen N. Rao
  2020-07-21 11:48 ` [PATCH 2/3] docs: staging/kprobes.rst: Move references to a separate appendix Naveen N. Rao
                   ` (3 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: Naveen N. Rao @ 2020-07-21 11:48 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: linux-doc, Masami Hiramatsu, linux-kernel

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.

Reported-by: Masami Hiramatsu <mhiramat@kernel.org>
Signed-off-by: Naveen N. Rao <naveen.n.rao@linux.vnet.ibm.com>
---
 Documentation/staging/kprobes.rst | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/Documentation/staging/kprobes.rst b/Documentation/staging/kprobes.rst
index 8baab8832c5b..620699f5df22 100644
--- a/Documentation/staging/kprobes.rst
+++ b/Documentation/staging/kprobes.rst
@@ -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
 ===================
-- 
2.25.4


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH 2/3] docs: staging/kprobes.rst: Move references to a separate appendix
  2020-07-21 11:48 [PATCH 0/3] docs: kprobes: Update URLs and move under trace/ Naveen N. Rao
  2020-07-21 11:48 ` [PATCH 1/3] docs: staging/kprobes.rst: Update some of the references Naveen N. Rao
@ 2020-07-21 11:48 ` Naveen N. Rao
  2020-07-21 11:48 ` [PATCH 3/3] docs: Move kprobes.rst from staging/ to trace/ Naveen N. Rao
                   ` (2 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: Naveen N. Rao @ 2020-07-21 11:48 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: linux-doc, Masami Hiramatsu, linux-kernel

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.

Signed-off-by: Naveen N. Rao <naveen.n.rao@linux.vnet.ibm.com>
---
 Documentation/staging/kprobes.rst | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/Documentation/staging/kprobes.rst b/Documentation/staging/kprobes.rst
index 620699f5df22..b757b6dfd3d4 100644
--- a/Documentation/staging/kprobes.rst
+++ b/Documentation/staging/kprobes.rst
@@ -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
+
-- 
2.25.4


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [PATCH 3/3] docs: Move kprobes.rst from staging/ to trace/
  2020-07-21 11:48 [PATCH 0/3] docs: kprobes: Update URLs and move under trace/ Naveen N. Rao
  2020-07-21 11:48 ` [PATCH 1/3] docs: staging/kprobes.rst: Update some of the references Naveen N. Rao
  2020-07-21 11:48 ` [PATCH 2/3] docs: staging/kprobes.rst: Move references to a separate appendix Naveen N. Rao
@ 2020-07-21 11:48 ` Naveen N. Rao
  2020-07-21 13:31 ` [PATCH 0/3] docs: kprobes: Update URLs and move under trace/ Masami Hiramatsu
  2020-07-23 20:01 ` Jonathan Corbet
  4 siblings, 0 replies; 6+ messages in thread
From: Naveen N. Rao @ 2020-07-21 11:48 UTC (permalink / raw)
  To: Jonathan Corbet; +Cc: linux-doc, Masami Hiramatsu, linux-kernel

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

Signed-off-by: Naveen N. Rao <naveen.n.rao@linux.vnet.ibm.com>
---
 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%)

diff --git a/Documentation/staging/index.rst b/Documentation/staging/index.rst
index 184e6aece0a7..abd0d18254d2 100644
--- a/Documentation/staging/index.rst
+++ b/Documentation/staging/index.rst
@@ -7,7 +7,6 @@ Unsorted Documentation
    :maxdepth: 2
 
    crc32
-   kprobes
    lzo
    remoteproc
    rpmsg
diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
index 7d83156c9ac1..879ebb9f647d 100644
--- a/Documentation/trace/index.rst
+++ b/Documentation/trace/index.rst
@@ -9,6 +9,7 @@ Linux Tracing Technologies
    tracepoint-analysis
    ftrace
    ftrace-uses
+   kprobes
    kprobetrace
    uprobetracer
    tracepoints
diff --git a/Documentation/staging/kprobes.rst b/Documentation/trace/kprobes.rst
similarity index 100%
rename from Documentation/staging/kprobes.rst
rename to Documentation/trace/kprobes.rst
-- 
2.25.4


^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH 0/3] docs: kprobes: Update URLs and move under trace/
  2020-07-21 11:48 [PATCH 0/3] docs: kprobes: Update URLs and move under trace/ Naveen N. Rao
                   ` (2 preceding siblings ...)
  2020-07-21 11:48 ` [PATCH 3/3] docs: Move kprobes.rst from staging/ to trace/ Naveen N. Rao
@ 2020-07-21 13:31 ` Masami Hiramatsu
  2020-07-23 20:01 ` Jonathan Corbet
  4 siblings, 0 replies; 6+ messages in thread
From: Masami Hiramatsu @ 2020-07-21 13:31 UTC (permalink / raw)
  To: Naveen N. Rao; +Cc: Jonathan Corbet, linux-doc, Masami Hiramatsu, linux-kernel

Hi Naveen,

On Tue, 21 Jul 2020 17:18:19 +0530
"Naveen N. Rao" <naveen.n.rao@linux.vnet.ibm.com> wrote:

> 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!

Acked-by: Masami Hiramatsu <mhiramat@kernel.org>

for this series.

Thanks!

> 
> - 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
> -- 
> 2.25.4
> 


-- 
Masami Hiramatsu <mhiramat@kernel.org>

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH 0/3] docs: kprobes: Update URLs and move under trace/
  2020-07-21 11:48 [PATCH 0/3] docs: kprobes: Update URLs and move under trace/ Naveen N. Rao
                   ` (3 preceding siblings ...)
  2020-07-21 13:31 ` [PATCH 0/3] docs: kprobes: Update URLs and move under trace/ Masami Hiramatsu
@ 2020-07-23 20:01 ` Jonathan Corbet
  4 siblings, 0 replies; 6+ messages in thread
From: Jonathan Corbet @ 2020-07-23 20:01 UTC (permalink / raw)
  To: Naveen N. Rao; +Cc: linux-doc, Masami Hiramatsu, linux-kernel

On Tue, 21 Jul 2020 17:18:19 +0530
"Naveen N. Rao" <naveen.n.rao@linux.vnet.ibm.com> wrote:

> 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%)

I've applied the set, thanks.

jon

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, back to index

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-21 11:48 [PATCH 0/3] docs: kprobes: Update URLs and move under trace/ Naveen N. Rao
2020-07-21 11:48 ` [PATCH 1/3] docs: staging/kprobes.rst: Update some of the references Naveen N. Rao
2020-07-21 11:48 ` [PATCH 2/3] docs: staging/kprobes.rst: Move references to a separate appendix Naveen N. Rao
2020-07-21 11:48 ` [PATCH 3/3] docs: Move kprobes.rst from staging/ to trace/ Naveen N. Rao
2020-07-21 13:31 ` [PATCH 0/3] docs: kprobes: Update URLs and move under trace/ Masami Hiramatsu
2020-07-23 20:01 ` Jonathan Corbet

Linux-Doc Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-doc/0 linux-doc/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-doc linux-doc/ https://lore.kernel.org/linux-doc \
		linux-doc@vger.kernel.org
	public-inbox-index linux-doc

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-doc


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git