Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation: fix admin-guide doc refs

Make admin-guide document refs valid.

Signed-off-by: Tom Saeger <tom.saeger@oracle.com>
Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Tom Saeger and committed by
Jonathan Corbet
3ba9b1b8 66ccc64f

+19 -14
+1 -1
Documentation/ABI/stable/sysfs-devices
··· 1 1 # Note: This documents additional properties of any device beyond what 2 - # is documented in Documentation/sysfs-rules.txt 2 + # is documented in Documentation/admin-guide/sysfs-rules.rst 3 3 4 4 What: /sys/devices/*/of_node 5 5 Date: February 2015
+4 -2
Documentation/ABI/testing/sysfs-devices-system-cpu
··· 187 187 This switch controls the boost setting for the whole system. 188 188 Boosting allows the CPU and the firmware to run at a frequency 189 189 beyound it's nominal limit. 190 - More details can be found in Documentation/cpu-freq/boost.txt 190 + More details can be found in 191 + Documentation/admin-guide/pm/cpufreq.rst 191 192 192 193 193 194 What: /sys/devices/system/cpu/cpu#/crash_notes ··· 224 223 no_turbo: limits the driver to selecting P states below the turbo 225 224 frequency range. 226 225 227 - More details can be found in Documentation/cpu-freq/intel-pstate.txt 226 + More details can be found in 227 + Documentation/admin-guide/pm/intel_pstate.rst 228 228 229 229 What: /sys/devices/system/cpu/cpu*/cache/index*/<set_of_attributes_mentioned_below> 230 230 Date: July 2014(documented, existed before August 2008)
+4 -2
Documentation/ABI/testing/sysfs-power
··· 18 18 Writing one of the above strings to this file causes the system 19 19 to transition into the corresponding state, if available. 20 20 21 - See Documentation/power/states.txt for more information. 21 + See Documentation/admin-guide/pm/sleep-states.rst for more 22 + information. 22 23 23 24 What: /sys/power/mem_sleep 24 25 Date: November 2016 ··· 36 35 represented by it to be used on subsequent attempts to suspend 37 36 the system. 38 37 39 - See Documentation/power/states.txt for more information. 38 + See Documentation/admin-guide/pm/sleep-states.rst for more 39 + information. 40 40 41 41 What: /sys/power/disk 42 42 Date: September 2006
+1 -1
Documentation/admin-guide/README.rst
··· 350 350 help debugging the problem. The text above the dump is also 351 351 important: it tells something about why the kernel dumped code (in 352 352 the above example, it's due to a bad kernel pointer). More information 353 - on making sense of the dump is in Documentation/admin-guide/oops-tracing.rst 353 + on making sense of the dump is in Documentation/admin-guide/bug-hunting.rst 354 354 355 355 - If you compiled the kernel with CONFIG_KALLSYMS you can send the dump 356 356 as is, otherwise you will have to use the ``ksymoops`` program to make
+1 -1
Documentation/admin-guide/kernel-parameters.txt
··· 3134 3134 3135 3135 plip= [PPT,NET] Parallel port network link 3136 3136 Format: { parport<nr> | timid | 0 } 3137 - See also Documentation/parport.txt. 3137 + See also Documentation/admin-guide/parport.rst. 3138 3138 3139 3139 pmtmr= [X86] Manual setup of pmtmr I/O Port. 3140 3140 Override pmtimer IOPort with a hex value.
+2 -2
Documentation/admin-guide/reporting-bugs.rst
··· 94 94 95 95 If the failure includes an "OOPS:", take a picture of the screen, capture 96 96 a netconsole trace, or type the message from your screen into the bug 97 - report. Please read "Documentation/admin-guide/oops-tracing.rst" before posting your 97 + report. Please read "Documentation/admin-guide/bug-hunting.rst" before posting your 98 98 bug report. This explains what you should do with the "Oops" information 99 99 to make it useful to the recipient. 100 100 ··· 120 120 [4.2.] Kernel .config file: 121 121 [5.] Most recent kernel version which did not have the bug: 122 122 [6.] Output of Oops.. message (if applicable) with symbolic information 123 - resolved (see Documentation/admin-guide/oops-tracing.rst) 123 + resolved (see Documentation/admin-guide/bug-hunting.rst) 124 124 [7.] A small shell script or example program which triggers the 125 125 problem (if possible) 126 126 [8.] Environment
+3 -3
Documentation/laptops/laptop-mode.txt
··· 184 184 DO_CPU: 185 185 186 186 Enable CPU frequency scaling when in laptop mode. (Requires CPUFreq to be setup. 187 - See Documentation/cpu-freq/user-guide.txt for more info. Disabled by default.) 187 + See Documentation/admin-guide/pm/cpufreq.rst for more info. Disabled by default.) 188 188 189 189 CPU_MAXFREQ: 190 190 ··· 287 287 288 288 # Should the maximum CPU frequency be adjusted down while on battery? 289 289 # Requires CPUFreq to be setup. 290 - # See Documentation/cpu-freq/user-guide.txt for more info 290 + # See Documentation/admin-guide/pm/cpufreq.rst for more info 291 291 #DO_CPU=0 292 292 293 293 # When on battery what is the maximum CPU speed that the system should ··· 378 378 DIRTY_RATIO=${DIRTY_RATIO:-'40'} 379 379 380 380 # cpu frequency scaling 381 - # See Documentation/cpu-freq/user-guide.txt for more info 381 + # See Documentation/admin-guide/pm/cpufreq.rst for more info 382 382 DO_CPU=${CPU_MANAGE:-'0'} 383 383 CPU_MAXFREQ=${CPU_MAXFREQ:-'slowest'} 384 384
+1 -1
Documentation/media/v4l-drivers/bttv.rst
··· 307 307 screen. See Documentation/admin-guide/serial-console.rst for details on setting 308 308 up a serial console. 309 309 310 - Read Documentation/admin-guide/oops-tracing.rst to learn how to get any useful 310 + Read Documentation/admin-guide/bug-hunting.rst to learn how to get any useful 311 311 information out of a register+stack dump printed by the kernel on 312 312 protection faults (so-called "kernel oops"). 313 313
+2 -1
Documentation/power/interface.txt
··· 24 24 25 25 If one of the strings listed in /sys/power/state is written to it, the system 26 26 will attempt to transition into the corresponding sleep state. Refer to 27 - Documentation/power/states.txt for a description of each of those states. 27 + Documentation/admin-guide/pm/sleep-states.rst for a description of each of 28 + those states. 28 29 29 30 /sys/power/disk controls the operating mode of hibernation (Suspend-to-Disk). 30 31 Specifically, it tells the kernel what to do after creating a hibernation image.