Skip to contentSkip to conversation

lib/Kconfig.debug: correct documentation paths

PATCH Superseded Hans Holmberg 3 participants 6 messages Dec 13, 2016 – Mar 16, 2017 Library code

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 lib/Kconfig.debug: correct documentation paths

A bunch of documentation files have moved, correct the paths.

---
 lib/Kconfig.debug | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)
lib/Kconfig.debug +10 -9
index e6327d1..18ffa80 100644
@@ -130,7 +130,8 @@ config DYNAMIC_DEBUG
 		nullarbor:~ # echo -n 'func svc_process -p' >
 						<debugfs>/dynamic_debug/control
 
-	  See Documentation/dynamic-debug-howto.txt for additional information.
+	  See Documentation/admin-guide/dynamic-debug-howto.rst for additional
+	  information.
 
 endmenu # "printk and dmesg options"
 
@@ -194,8 +195,8 @@ config GDB_SCRIPTS
 	  build directory. If you load vmlinux into gdb, the helper
 	  scripts will be automatically imported by gdb as well, and
 	  additional functions are available to analyze a Linux kernel
-	  instance. See Documentation/gdb-kernel-debugging.txt for further
-	  details.
+	  instance. See Documentation/dev-tools/gdb-kernel-debugging.rst
+	  for further details.
 
 config ENABLE_WARN_DEPRECATED
 	bool "Enable __deprecated logic"
@@ -404,8 +405,8 @@ config MAGIC_SYSRQ
 	  by pressing various keys while holding SysRq (Alt+PrintScreen). It
 	  also works on a serial console (on PC hardware at least), if you
 	  send a BREAK and then within 5 seconds a command keypress. The
-	  keys are documented in <file:Documentation/sysrq.txt>. Don't say Y
-	  unless you really know what this hack does.
+	  keys are documented in <file:Documentation/admin-guide/sysrq.rst>.
+	  Don't say Y unless you really know what this hack does.
 
 config MAGIC_SYSRQ_DEFAULT_ENABLE
 	hex "Enable magic SysRq key functions by default"
@@ -414,7 +415,7 @@ config MAGIC_SYSRQ_DEFAULT_ENABLE
 	help
 	  Specifies which SysRq key functions are enabled by default.
 	  This may be set to 1 or 0 to enable or disable them all, or
-	  to a bitmask as described in Documentation/sysrq.txt.
+	  to a bitmask as described in Documentation/admin-guide/sysrq.rst.
 
 config DEBUG_KERNEL
 	bool "Kernel debugging"
@@ -542,8 +543,8 @@ config DEBUG_KMEMLEAK
 	  difference being that the orphan objects are not freed but
 	  only shown in /sys/kernel/debug/kmemleak. Enabling this
 	  feature will introduce an overhead to memory
-	  allocations. See Documentation/kmemleak.txt for more
-	  details.
+	  allocations. See Documentation/dev-tools/kmemleak.rst for
+	  more details.
 
 	  Enabling DEBUG_SLAB or SLUB_DEBUG may increase the chances
 	  of finding leaks due to the slab objects poisoning.
@@ -739,7 +740,7 @@ config KCOV
 	  different machines and across reboots. If you need stable PC values,
 	  disable RANDOMIZE_BASE.
 
-	  For more details, see Documentation/kcov.txt.
+	  For more details, see Documentation/dev-tools/kcov.rst.
 
 config KCOV_INSTRUMENT_ALL
 	bool "Instrument all code by default"
Signature · 1 line
1.9.1
#1 lore raw
Quoted 1 line · On Tue, 13 Dec 2016 15:40:57 +0100 Hans Holmberg <[email protected]> wrote:

A bunch of documentation files have moved, correct the paths.

Good catch. Guess I'm as good a messenger as anybody else for this one; applied to docs-next, thanks.

jon

#2 lore raw
In reply to Hans Holmberg
Quoted 7 lines · Hans Holmberg

A bunch of documentation files have moved, correct the paths.

---
 lib/Kconfig.debug | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

Hi Jon,

What happened with this patch? I am asking because on top of next-20170224 I found some more sysrq.txt obsolete paths... including the ones fixed here. I am not sure whether I am fixing something already fixed?

Best regards,
Krzysztof

Quoted 68 lines
lib/Kconfig.debug +10 -10
index e6327d1..18ffa80 100644
@@ -130,7 +130,8 @@ config DYNAMIC_DEBUG
                nullarbor:~ # echo -n 'func svc_process -p' >
                                                <debugfs>/dynamic_debug/control
 
-         See Documentation/dynamic-debug-howto.txt for additional information.
+         See Documentation/admin-guide/dynamic-debug-howto.rst for additional
+         information.
 
 endmenu # "printk and dmesg options"
 
@@ -194,8 +195,8 @@ config GDB_SCRIPTS
          build directory. If you load vmlinux into gdb, the helper
          scripts will be automatically imported by gdb as well, and
          additional functions are available to analyze a Linux kernel
-         instance. See Documentation/gdb-kernel-debugging.txt for further
-         details.
+         instance. See Documentation/dev-tools/gdb-kernel-debugging.rst
+         for further details.
 
 config ENABLE_WARN_DEPRECATED
        bool "Enable __deprecated logic"
@@ -404,8 +405,8 @@ config MAGIC_SYSRQ
          by pressing various keys while holding SysRq (Alt+PrintScreen). It
          also works on a serial console (on PC hardware at least), if you
          send a BREAK and then within 5 seconds a command keypress. The
-         keys are documented in <file:Documentation/sysrq.txt>. Don't say Y
-         unless you really know what this hack does.
+         keys are documented in <file:Documentation/admin-guide/sysrq.rst>.
+         Don't say Y unless you really know what this hack does.
 
 config MAGIC_SYSRQ_DEFAULT_ENABLE
        hex "Enable magic SysRq key functions by default"
@@ -414,7 +415,7 @@ config MAGIC_SYSRQ_DEFAULT_ENABLE
        help
          Specifies which SysRq key functions are enabled by default.
          This may be set to 1 or 0 to enable or disable them all, or
-         to a bitmask as described in Documentation/sysrq.txt.
+         to a bitmask as described in Documentation/admin-guide/sysrq.rst.
 
 config DEBUG_KERNEL
        bool "Kernel debugging"
@@ -542,8 +543,8 @@ config DEBUG_KMEMLEAK
          difference being that the orphan objects are not freed but
          only shown in /sys/kernel/debug/kmemleak. Enabling this
          feature will introduce an overhead to memory
-         allocations. See Documentation/kmemleak.txt for more
-         details.
+         allocations. See Documentation/dev-tools/kmemleak.rst for
+         more details.
 
          Enabling DEBUG_SLAB or SLUB_DEBUG may increase the chances
          of finding leaks due to the slab objects poisoning.
@@ -739,7 +740,7 @@ config KCOV
          different machines and across reboots. If you need stable PC values,
          disable RANDOMIZE_BASE.
 
-         For more details, see Documentation/kcov.txt.
+         For more details, see Documentation/dev-tools/kcov.rst.
 
 config KCOV_INSTRUMENT_ALL
        bool "Instrument all code by default"
--

1.9.1

#3 lore raw
Quoted 4 lines · On Fri, 24 Feb 2017 10:36:20 +0200 Krzysztof Kozlowski <[email protected]> wrote:

What happened with this patch? I am asking because on top of next-20170224 I found some more sysrq.txt obsolete paths... including the ones fixed here. I am not sure whether I am fixing something already fixed?

What happened, most likely, is that I saw /lib/Kconfig.debug and assumed it was one of the many patches sent my way that aren't really up to me to handle. But nobody else really owns /lib either, I guess. I've dug the patch out of my archive and will get it in.

Thanks,

jon

#4 lore raw
Quoted 8 lines · Jonathan Corbet
Quoted 4 lines · On Fri, 24 Feb 2017 10:36:20 +0200 Krzysztof Kozlowski <[email protected]> wrote:

What happened with this patch? I am asking because on top of next-20170224 I found some more sysrq.txt obsolete paths... including the ones fixed here. I am not sure whether I am fixing something already fixed?

Quoted 5 lines

What happened, most likely, is that I saw /lib/Kconfig.debug and assumed it was one of the many patches sent my way that aren't really up to me to handle. But nobody else really owns /lib either, I guess. I've dug the patch out of my archive and will get it in.

Greatm thank you!

Best regards,
Krzysztof

#5 lore raw
In reply to Jonathan Corbet
Quoted 8 lines · Jonathan Corbet
Quoted 4 lines · On Fri, 24 Feb 2017 10:36:20 +0200 Krzysztof Kozlowski <[email protected]> wrote:

What happened with this patch? I am asking because on top of next-20170224 I found some more sysrq.txt obsolete paths... including the ones fixed here. I am not sure whether I am fixing something already fixed?

Quoted 5 lines

What happened, most likely, is that I saw /lib/Kconfig.debug and assumed it was one of the many patches sent my way that aren't really up to me to handle. But nobody else really owns /lib either, I guess. I've dug the patch out of my archive and will get it in.

Great! I just noticed that the patch does not apply, so i'll rebase it and send out a V2.

Thanks,
Hans