diff options
author | Jonathan Corbet <corbet@lwn.net> | 2017-10-12 13:23:12 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2017-10-12 13:23:12 -0400 |
commit | 3211ba4157b547c182058711d1ad4a418df5d6e9 (patch) | |
tree | 454db16eafdf375d0eaedf8c800d56fa85b66a5c | |
parent | e8939222dced668fc5cae02b0b601af069801107 (diff) | |
parent | f2b41874240411a7d06aac2dc864a389c93183cc (diff) |
Merge branch 'refs' into docs-next
Tom Saeger says:
Recently, while reading up on binfmt I attempted to open a document ref
only to find it was invalid. I did a quick grep, found all the
binfmt_misc related broken refs and sent a patch.
Fine. Easy.
Then I wondered, "how many broken doc refs are there?".
Turns out with all the recent doc moves, quite a few.
I went about fixing just those found in Documentation/,
except those in Documentation/translations/ and
Documentation/devicetree/ for now.
Most of these changes were s/txt/rst/ or fixing up a path to an obvious
new location. Some required going back to v4.10 v4.4 or some other
version to sleuth-out what content was actually being referenced and
then fixing the reference to point to the new file with that content.
31 files changed, 58 insertions, 54 deletions
diff --git a/Documentation/ABI/stable/sysfs-devices b/Documentation/ABI/stable/sysfs-devices index 35c457f8ce73..4404bd9b96c1 100644 --- a/Documentation/ABI/stable/sysfs-devices +++ b/Documentation/ABI/stable/sysfs-devices | |||
@@ -1,5 +1,5 @@ | |||
1 | # Note: This documents additional properties of any device beyond what | 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 | What: /sys/devices/*/of_node | 4 | What: /sys/devices/*/of_node |
5 | Date: February 2015 | 5 | Date: February 2015 |
diff --git a/Documentation/ABI/testing/evm b/Documentation/ABI/testing/evm index 8374d4557e5d..ca622c9aa24c 100644 --- a/Documentation/ABI/testing/evm +++ b/Documentation/ABI/testing/evm | |||
@@ -18,6 +18,6 @@ Description: | |||
18 | in the initramfs, which has already been measured as part | 18 | in the initramfs, which has already been measured as part |
19 | of the trusted boot. For more information on creating and | 19 | of the trusted boot. For more information on creating and |
20 | loading existing trusted/encrypted keys, refer to: | 20 | loading existing trusted/encrypted keys, refer to: |
21 | Documentation/keys-trusted-encrypted.txt. (A sample dracut | 21 | Documentation/security/keys/trusted-encrypted.rst. (A sample |
22 | patch, which loads the trusted/encrypted key and enables | 22 | dracut patch, which loads the trusted/encrypted key and enables |
23 | EVM, is available from http://linux-ima.sourceforge.net/#EVM.) | 23 | EVM, is available from http://linux-ima.sourceforge.net/#EVM.) |
diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu index f3d5817c4ef0..d6d862db3b5d 100644 --- a/Documentation/ABI/testing/sysfs-devices-system-cpu +++ b/Documentation/ABI/testing/sysfs-devices-system-cpu | |||
@@ -187,7 +187,8 @@ Description: Processor frequency boosting control | |||
187 | This switch controls the boost setting for the whole system. | 187 | This switch controls the boost setting for the whole system. |
188 | Boosting allows the CPU and the firmware to run at a frequency | 188 | Boosting allows the CPU and the firmware to run at a frequency |
189 | beyound it's nominal limit. | 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 | What: /sys/devices/system/cpu/cpu#/crash_notes | 194 | What: /sys/devices/system/cpu/cpu#/crash_notes |
@@ -223,7 +224,8 @@ Description: Parameters for the Intel P-state driver | |||
223 | no_turbo: limits the driver to selecting P states below the turbo | 224 | no_turbo: limits the driver to selecting P states below the turbo |
224 | frequency range. | 225 | frequency range. |
225 | 226 | ||
226 | More details can be found in Documentation/cpu-freq/intel-pstate.txt | 227 | More details can be found in |
228 | Documentation/admin-guide/pm/intel_pstate.rst | ||
227 | 229 | ||
228 | What: /sys/devices/system/cpu/cpu*/cache/index*/<set_of_attributes_mentioned_below> | 230 | What: /sys/devices/system/cpu/cpu*/cache/index*/<set_of_attributes_mentioned_below> |
229 | Date: July 2014(documented, existed before August 2008) | 231 | Date: July 2014(documented, existed before August 2008) |
diff --git a/Documentation/ABI/testing/sysfs-power b/Documentation/ABI/testing/sysfs-power index 713cab1d5f12..4b2e13e5f020 100644 --- a/Documentation/ABI/testing/sysfs-power +++ b/Documentation/ABI/testing/sysfs-power | |||
@@ -18,7 +18,8 @@ Description: | |||
18 | Writing one of the above strings to this file causes the system | 18 | Writing one of the above strings to this file causes the system |
19 | to transition into the corresponding state, if available. | 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 | What: /sys/power/mem_sleep | 24 | What: /sys/power/mem_sleep |
24 | Date: November 2016 | 25 | Date: November 2016 |
@@ -35,7 +36,8 @@ Description: | |||
35 | represented by it to be used on subsequent attempts to suspend | 36 | represented by it to be used on subsequent attempts to suspend |
36 | the system. | 37 | the system. |
37 | 38 | ||
38 | See Documentation/power/states.txt for more information. | 39 | See Documentation/admin-guide/pm/sleep-states.rst for more |
40 | information. | ||
39 | 41 | ||
40 | What: /sys/power/disk | 42 | What: /sys/power/disk |
41 | Date: September 2006 | 43 | Date: September 2006 |
diff --git a/Documentation/admin-guide/README.rst b/Documentation/admin-guide/README.rst index b5343c5aa224..63066db39910 100644 --- a/Documentation/admin-guide/README.rst +++ b/Documentation/admin-guide/README.rst | |||
@@ -350,7 +350,7 @@ If something goes wrong | |||
350 | help debugging the problem. The text above the dump is also | 350 | help debugging the problem. The text above the dump is also |
351 | important: it tells something about why the kernel dumped code (in | 351 | important: it tells something about why the kernel dumped code (in |
352 | the above example, it's due to a bad kernel pointer). More information | 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 | - If you compiled the kernel with CONFIG_KALLSYMS you can send the dump | 355 | - If you compiled the kernel with CONFIG_KALLSYMS you can send the dump |
356 | as is, otherwise you will have to use the ``ksymoops`` program to make | 356 | as is, otherwise you will have to use the ``ksymoops`` program to make |
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index a3427399fd07..97a76eea7389 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt | |||
@@ -314,7 +314,7 @@ | |||
314 | amijoy.map= [HW,JOY] Amiga joystick support | 314 | amijoy.map= [HW,JOY] Amiga joystick support |
315 | Map of devices attached to JOY0DAT and JOY1DAT | 315 | Map of devices attached to JOY0DAT and JOY1DAT |
316 | Format: <a>,<b> | 316 | Format: <a>,<b> |
317 | See also Documentation/input/joystick.txt | 317 | See also Documentation/input/joydev/joystick.rst |
318 | 318 | ||
319 | analog.map= [HW,JOY] Analog joystick and gamepad support | 319 | analog.map= [HW,JOY] Analog joystick and gamepad support |
320 | Specifies type or capabilities of an analog joystick | 320 | Specifies type or capabilities of an analog joystick |
@@ -439,7 +439,7 @@ | |||
439 | bttv.card= [HW,V4L] bttv (bt848 + bt878 based grabber cards) | 439 | bttv.card= [HW,V4L] bttv (bt848 + bt878 based grabber cards) |
440 | bttv.radio= Most important insmod options are available as | 440 | bttv.radio= Most important insmod options are available as |
441 | kernel args too. | 441 | kernel args too. |
442 | bttv.pll= See Documentation/video4linux/bttv/Insmod-options | 442 | bttv.pll= See Documentation/media/v4l-drivers/bttv.rst |
443 | bttv.tuner= | 443 | bttv.tuner= |
444 | 444 | ||
445 | bulk_remove=off [PPC] This parameter disables the use of the pSeries | 445 | bulk_remove=off [PPC] This parameter disables the use of the pSeries |
@@ -724,7 +724,7 @@ | |||
724 | db9.dev[2|3]= [HW,JOY] Multisystem joystick support via parallel port | 724 | db9.dev[2|3]= [HW,JOY] Multisystem joystick support via parallel port |
725 | (one device per port) | 725 | (one device per port) |
726 | Format: <port#>,<type> | 726 | Format: <port#>,<type> |
727 | See also Documentation/input/joystick-parport.txt | 727 | See also Documentation/input/devices/joystick-parport.rst |
728 | 728 | ||
729 | ddebug_query= [KNL,DYNAMIC_DEBUG] Enable debug messages at early boot | 729 | ddebug_query= [KNL,DYNAMIC_DEBUG] Enable debug messages at early boot |
730 | time. See | 730 | time. See |
@@ -1220,7 +1220,7 @@ | |||
1220 | [HW,JOY] Multisystem joystick and NES/SNES/PSX pad | 1220 | [HW,JOY] Multisystem joystick and NES/SNES/PSX pad |
1221 | support via parallel port (up to 5 devices per port) | 1221 | support via parallel port (up to 5 devices per port) |
1222 | Format: <port#>,<pad1>,<pad2>,<pad3>,<pad4>,<pad5> | 1222 | Format: <port#>,<pad1>,<pad2>,<pad3>,<pad4>,<pad5> |
1223 | See also Documentation/input/joystick-parport.txt | 1223 | See also Documentation/input/devices/joystick-parport.rst |
1224 | 1224 | ||
1225 | gamma= [HW,DRM] | 1225 | gamma= [HW,DRM] |
1226 | 1226 | ||
@@ -1766,7 +1766,7 @@ | |||
1766 | ivrs_acpihid[00:14.5]=AMD0020:0 | 1766 | ivrs_acpihid[00:14.5]=AMD0020:0 |
1767 | 1767 | ||
1768 | js= [HW,JOY] Analog joystick | 1768 | js= [HW,JOY] Analog joystick |
1769 | See Documentation/input/joystick.txt. | 1769 | See Documentation/input/joydev/joystick.rst. |
1770 | 1770 | ||
1771 | nokaslr [KNL] | 1771 | nokaslr [KNL] |
1772 | When CONFIG_RANDOMIZE_BASE is set, this disables | 1772 | When CONFIG_RANDOMIZE_BASE is set, this disables |
@@ -2251,7 +2251,7 @@ | |||
2251 | See Documentation/admin-guide/pm/sleep-states.rst. | 2251 | See Documentation/admin-guide/pm/sleep-states.rst. |
2252 | 2252 | ||
2253 | meye.*= [HW] Set MotionEye Camera parameters | 2253 | meye.*= [HW] Set MotionEye Camera parameters |
2254 | See Documentation/video4linux/meye.txt. | 2254 | See Documentation/media/v4l-drivers/meye.rst. |
2255 | 2255 | ||
2256 | mfgpt_irq= [IA-32] Specify the IRQ to use for the | 2256 | mfgpt_irq= [IA-32] Specify the IRQ to use for the |
2257 | Multi-Function General Purpose Timers on AMD Geode | 2257 | Multi-Function General Purpose Timers on AMD Geode |
@@ -3134,7 +3134,7 @@ | |||
3134 | 3134 | ||
3135 | plip= [PPT,NET] Parallel port network link | 3135 | plip= [PPT,NET] Parallel port network link |
3136 | Format: { parport<nr> | timid | 0 } | 3136 | Format: { parport<nr> | timid | 0 } |
3137 | See also Documentation/parport.txt. | 3137 | See also Documentation/admin-guide/parport.rst. |
3138 | 3138 | ||
3139 | pmtmr= [X86] Manual setup of pmtmr I/O Port. | 3139 | pmtmr= [X86] Manual setup of pmtmr I/O Port. |
3140 | Override pmtimer IOPort with a hex value. | 3140 | Override pmtimer IOPort with a hex value. |
@@ -4205,7 +4205,7 @@ | |||
4205 | TurboGraFX parallel port interface | 4205 | TurboGraFX parallel port interface |
4206 | Format: | 4206 | Format: |
4207 | <port#>,<js1>,<js2>,<js3>,<js4>,<js5>,<js6>,<js7> | 4207 | <port#>,<js1>,<js2>,<js3>,<js4>,<js5>,<js6>,<js7> |
4208 | See also Documentation/input/joystick-parport.txt | 4208 | See also Documentation/input/devices/joystick-parport.rst |
4209 | 4209 | ||
4210 | udbg-immortal [PPC] When debugging early kernel crashes that | 4210 | udbg-immortal [PPC] When debugging early kernel crashes that |
4211 | happen after console_init() and before a proper | 4211 | happen after console_init() and before a proper |
diff --git a/Documentation/admin-guide/reporting-bugs.rst b/Documentation/admin-guide/reporting-bugs.rst index 26b60b419652..4650edb8840a 100644 --- a/Documentation/admin-guide/reporting-bugs.rst +++ b/Documentation/admin-guide/reporting-bugs.rst | |||
@@ -94,7 +94,7 @@ step-by-step instructions for how a user can trigger the bug. | |||
94 | 94 | ||
95 | If the failure includes an "OOPS:", take a picture of the screen, capture | 95 | If the failure includes an "OOPS:", take a picture of the screen, capture |
96 | a netconsole trace, or type the message from your screen into the bug | 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 | bug report. This explains what you should do with the "Oops" information | 98 | bug report. This explains what you should do with the "Oops" information |
99 | to make it useful to the recipient. | 99 | to make it useful to the recipient. |
100 | 100 | ||
@@ -120,7 +120,7 @@ summary from [1.]>" for easy identification by the developers:: | |||
120 | [4.2.] Kernel .config file: | 120 | [4.2.] Kernel .config file: |
121 | [5.] Most recent kernel version which did not have the bug: | 121 | [5.] Most recent kernel version which did not have the bug: |
122 | [6.] Output of Oops.. message (if applicable) with symbolic information | 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 | [7.] A small shell script or example program which triggers the | 124 | [7.] A small shell script or example program which triggers the |
125 | problem (if possible) | 125 | problem (if possible) |
126 | [8.] Environment | 126 | [8.] Environment |
diff --git a/Documentation/driver-api/usb/usb.rst b/Documentation/driver-api/usb/usb.rst index dba0f876b36f..078e981e2b16 100644 --- a/Documentation/driver-api/usb/usb.rst +++ b/Documentation/driver-api/usb/usb.rst | |||
@@ -690,9 +690,7 @@ The USB devices are now exported via debugfs: | |||
690 | This file is handy for status viewing tools in user mode, which can scan | 690 | This file is handy for status viewing tools in user mode, which can scan |
691 | the text format and ignore most of it. More detailed device status | 691 | the text format and ignore most of it. More detailed device status |
692 | (including class and vendor status) is available from device-specific | 692 | (including class and vendor status) is available from device-specific |
693 | files. For information about the current format of this file, see the | 693 | files. For information about the current format of this file, see below. |
694 | ``Documentation/usb/proc_usb_info.txt`` file in your Linux kernel | ||
695 | sources. | ||
696 | 694 | ||
697 | This file, in combination with the poll() system call, can also be used | 695 | This file, in combination with the poll() system call, can also be used |
698 | to detect when devices are added or removed:: | 696 | to detect when devices are added or removed:: |
diff --git a/Documentation/hid/hiddev.txt b/Documentation/hid/hiddev.txt index 6e8c9f1d2f22..638448707aa2 100644 --- a/Documentation/hid/hiddev.txt +++ b/Documentation/hid/hiddev.txt | |||
@@ -12,7 +12,7 @@ To support these disparate requirements, the Linux USB system provides | |||
12 | HID events to two separate interfaces: | 12 | HID events to two separate interfaces: |
13 | * the input subsystem, which converts HID events into normal input | 13 | * the input subsystem, which converts HID events into normal input |
14 | device interfaces (such as keyboard, mouse and joystick) and a | 14 | device interfaces (such as keyboard, mouse and joystick) and a |
15 | normalised event interface - see Documentation/input/input.txt | 15 | normalised event interface - see Documentation/input/input.rst |
16 | * the hiddev interface, which provides fairly raw HID events | 16 | * the hiddev interface, which provides fairly raw HID events |
17 | 17 | ||
18 | The data flow for a HID event produced by a device is something like | 18 | The data flow for a HID event produced by a device is something like |
diff --git a/Documentation/input/devices/xpad.rst b/Documentation/input/devices/xpad.rst index 5a709ab77c8d..b8bd65962dd8 100644 --- a/Documentation/input/devices/xpad.rst +++ b/Documentation/input/devices/xpad.rst | |||
@@ -230,4 +230,5 @@ Historic Edits | |||
230 | 2005-03-19 - Dominic Cerquetti <binary1230@yahoo.com> | 230 | 2005-03-19 - Dominic Cerquetti <binary1230@yahoo.com> |
231 | - added stuff for dance pads, new d-pad->axes mappings | 231 | - added stuff for dance pads, new d-pad->axes mappings |
232 | 232 | ||
233 | Later changes may be viewed with 'git log Documentation/input/xpad.txt' | 233 | Later changes may be viewed with |
234 | 'git log --follow Documentation/input/devices/xpad.rst' | ||
diff --git a/Documentation/laptops/laptop-mode.txt b/Documentation/laptops/laptop-mode.txt index 19276f5d195c..1c707fc9b141 100644 --- a/Documentation/laptops/laptop-mode.txt +++ b/Documentation/laptops/laptop-mode.txt | |||
@@ -184,7 +184,7 @@ is done when dirty_ratio is reached. | |||
184 | DO_CPU: | 184 | DO_CPU: |
185 | 185 | ||
186 | Enable CPU frequency scaling when in laptop mode. (Requires CPUFreq to be setup. | 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 | CPU_MAXFREQ: | 189 | CPU_MAXFREQ: |
190 | 190 | ||
@@ -287,7 +287,7 @@ MINIMUM_BATTERY_MINUTES=10 | |||
287 | 287 | ||
288 | # Should the maximum CPU frequency be adjusted down while on battery? | 288 | # Should the maximum CPU frequency be adjusted down while on battery? |
289 | # Requires CPUFreq to be setup. | 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 | #DO_CPU=0 | 291 | #DO_CPU=0 |
292 | 292 | ||
293 | # When on battery what is the maximum CPU speed that the system should | 293 | # When on battery what is the maximum CPU speed that the system should |
@@ -378,7 +378,7 @@ BATT_HD=${BATT_HD:-'4'} | |||
378 | DIRTY_RATIO=${DIRTY_RATIO:-'40'} | 378 | DIRTY_RATIO=${DIRTY_RATIO:-'40'} |
379 | 379 | ||
380 | # cpu frequency scaling | 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 | DO_CPU=${CPU_MANAGE:-'0'} | 382 | DO_CPU=${CPU_MANAGE:-'0'} |
383 | CPU_MAXFREQ=${CPU_MAXFREQ:-'slowest'} | 383 | CPU_MAXFREQ=${CPU_MAXFREQ:-'slowest'} |
384 | 384 | ||
diff --git a/Documentation/media/dvb-drivers/bt8xx.rst b/Documentation/media/dvb-drivers/bt8xx.rst index b43958b7340c..e3e387bdf498 100644 --- a/Documentation/media/dvb-drivers/bt8xx.rst +++ b/Documentation/media/dvb-drivers/bt8xx.rst | |||
@@ -18,7 +18,7 @@ General information | |||
18 | 18 | ||
19 | This class of cards has a bt878a as the PCI interface, and require the bttv driver | 19 | This class of cards has a bt878a as the PCI interface, and require the bttv driver |
20 | for accessing the i2c bus and the gpio pins of the bt8xx chipset. | 20 | for accessing the i2c bus and the gpio pins of the bt8xx chipset. |
21 | Please see Documentation/dvb/cards.txt => o Cards based on the Conexant Bt8xx PCI bridge: | 21 | Please see Documentation/media/dvb-drivers/cards.rst => o Cards based on the Conexant Bt8xx PCI bridge: |
22 | 22 | ||
23 | Compiling kernel please enable: | 23 | Compiling kernel please enable: |
24 | 24 | ||
@@ -45,7 +45,7 @@ Loading Modules | |||
45 | Regular case: If the bttv driver detects a bt8xx-based DVB card, all frontend and backend modules will be loaded automatically. | 45 | Regular case: If the bttv driver detects a bt8xx-based DVB card, all frontend and backend modules will be loaded automatically. |
46 | Exceptions are: | 46 | Exceptions are: |
47 | - Old TwinHan DST cards or clones with or without CA slot and not containing an Eeprom. | 47 | - Old TwinHan DST cards or clones with or without CA slot and not containing an Eeprom. |
48 | People running udev please see Documentation/dvb/udev.txt. | 48 | People running udev please see Documentation/media/dvb-drivers/udev.rst. |
49 | 49 | ||
50 | In the following cases overriding the PCI type detection for dvb-bt8xx might be necessary: | 50 | In the following cases overriding the PCI type detection for dvb-bt8xx might be necessary: |
51 | 51 | ||
@@ -72,7 +72,7 @@ Useful parameters for verbosity level and debugging the dst module: | |||
72 | The autodetected values are determined by the cards' "response string". | 72 | The autodetected values are determined by the cards' "response string". |
73 | In your logs see f. ex.: dst_get_device_id: Recognize [DSTMCI]. | 73 | In your logs see f. ex.: dst_get_device_id: Recognize [DSTMCI]. |
74 | For bug reports please send in a complete log with verbose=4 activated. | 74 | For bug reports please send in a complete log with verbose=4 activated. |
75 | Please also see Documentation/dvb/ci.txt. | 75 | Please also see Documentation/media/dvb-drivers/ci.rst. |
76 | 76 | ||
77 | Running multiple cards | 77 | Running multiple cards |
78 | ~~~~~~~~~~~~~~~~~~~~~~ | 78 | ~~~~~~~~~~~~~~~~~~~~~~ |
@@ -100,7 +100,7 @@ Examples of card ID's: | |||
100 | 100 | ||
101 | $ modprobe bttv card=113 card=135 | 101 | $ modprobe bttv card=113 card=135 |
102 | 102 | ||
103 | For a full list of card ID's please see Documentation/video4linux/CARDLIST.bttv. | 103 | For a full list of card ID's please see Documentation/media/v4l-drivers/bttv-cardlist.rst. |
104 | In case of further problems please subscribe and send questions to the mailing list: linux-dvb@linuxtv.org. | 104 | In case of further problems please subscribe and send questions to the mailing list: linux-dvb@linuxtv.org. |
105 | 105 | ||
106 | Probing the cards with broken PCI subsystem ID | 106 | Probing the cards with broken PCI subsystem ID |
diff --git a/Documentation/media/uapi/v4l/dev-sliced-vbi.rst b/Documentation/media/uapi/v4l/dev-sliced-vbi.rst index 9d6c860271cb..d311a6866b3b 100644 --- a/Documentation/media/uapi/v4l/dev-sliced-vbi.rst +++ b/Documentation/media/uapi/v4l/dev-sliced-vbi.rst | |||
@@ -431,7 +431,7 @@ MPEG stream. | |||
431 | *Historical context*: This format specification originates from a | 431 | *Historical context*: This format specification originates from a |
432 | custom, embedded, sliced VBI data format used by the ``ivtv`` driver. | 432 | custom, embedded, sliced VBI data format used by the ``ivtv`` driver. |
433 | This format has already been informally specified in the kernel sources | 433 | This format has already been informally specified in the kernel sources |
434 | in the file ``Documentation/video4linux/cx2341x/README.vbi`` . The | 434 | in the file ``Documentation/media/v4l-drivers/cx2341x.rst`` . The |
435 | maximum size of the payload and other aspects of this format are driven | 435 | maximum size of the payload and other aspects of this format are driven |
436 | by the CX23415 MPEG decoder's capabilities and limitations with respect | 436 | by the CX23415 MPEG decoder's capabilities and limitations with respect |
437 | to extracting, decoding, and displaying sliced VBI data embedded within | 437 | to extracting, decoding, and displaying sliced VBI data embedded within |
diff --git a/Documentation/media/uapi/v4l/extended-controls.rst b/Documentation/media/uapi/v4l/extended-controls.rst index a3e81c1d276b..dfe49ae57e78 100644 --- a/Documentation/media/uapi/v4l/extended-controls.rst +++ b/Documentation/media/uapi/v4l/extended-controls.rst | |||
@@ -284,7 +284,7 @@ enum v4l2_mpeg_stream_vbi_fmt - | |||
284 | * - ``V4L2_MPEG_STREAM_VBI_FMT_IVTV`` | 284 | * - ``V4L2_MPEG_STREAM_VBI_FMT_IVTV`` |
285 | - VBI in private packets, IVTV format (documented in the kernel | 285 | - VBI in private packets, IVTV format (documented in the kernel |
286 | sources in the file | 286 | sources in the file |
287 | ``Documentation/video4linux/cx2341x/README.vbi``) | 287 | ``Documentation/media/v4l-drivers/cx2341x.rst``) |
288 | 288 | ||
289 | 289 | ||
290 | 290 | ||
diff --git a/Documentation/media/uapi/v4l/pixfmt-reserved.rst b/Documentation/media/uapi/v4l/pixfmt-reserved.rst index 521adb795535..38af1472a4b4 100644 --- a/Documentation/media/uapi/v4l/pixfmt-reserved.rst +++ b/Documentation/media/uapi/v4l/pixfmt-reserved.rst | |||
@@ -52,7 +52,7 @@ please make a proposal on the linux-media mailing list. | |||
52 | `http://www.ivtvdriver.org/ <http://www.ivtvdriver.org/>`__ | 52 | `http://www.ivtvdriver.org/ <http://www.ivtvdriver.org/>`__ |
53 | 53 | ||
54 | The format is documented in the kernel sources in the file | 54 | The format is documented in the kernel sources in the file |
55 | ``Documentation/video4linux/cx2341x/README.hm12`` | 55 | ``Documentation/media/v4l-drivers/cx2341x.rst`` |
56 | * .. _V4L2-PIX-FMT-CPIA1: | 56 | * .. _V4L2-PIX-FMT-CPIA1: |
57 | 57 | ||
58 | - ``V4L2_PIX_FMT_CPIA1`` | 58 | - ``V4L2_PIX_FMT_CPIA1`` |
diff --git a/Documentation/media/v4l-drivers/bttv.rst b/Documentation/media/v4l-drivers/bttv.rst index 195ccaac2816..5f35e2fb5afa 100644 --- a/Documentation/media/v4l-drivers/bttv.rst +++ b/Documentation/media/v4l-drivers/bttv.rst | |||
@@ -307,7 +307,7 @@ console and let some terminal application log the messages. /me uses | |||
307 | screen. See Documentation/admin-guide/serial-console.rst for details on setting | 307 | screen. See Documentation/admin-guide/serial-console.rst for details on setting |
308 | up a serial console. | 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 | information out of a register+stack dump printed by the kernel on | 311 | information out of a register+stack dump printed by the kernel on |
312 | protection faults (so-called "kernel oops"). | 312 | protection faults (so-called "kernel oops"). |
313 | 313 | ||
diff --git a/Documentation/media/v4l-drivers/max2175.rst b/Documentation/media/v4l-drivers/max2175.rst index 04478c25d57a..b1a4c89fd869 100644 --- a/Documentation/media/v4l-drivers/max2175.rst +++ b/Documentation/media/v4l-drivers/max2175.rst | |||
@@ -7,7 +7,7 @@ The MAX2175 driver implements the following driver-specific controls: | |||
7 | ------------------------------- | 7 | ------------------------------- |
8 | Enable/Disable I2S output of the tuner. This is a private control | 8 | Enable/Disable I2S output of the tuner. This is a private control |
9 | that can be accessed only using the subdev interface. | 9 | that can be accessed only using the subdev interface. |
10 | Refer to Documentation/media/kapi/v4l2-controls for more details. | 10 | Refer to Documentation/media/kapi/v4l2-controls.rst for more details. |
11 | 11 | ||
12 | .. flat-table:: | 12 | .. flat-table:: |
13 | :header-rows: 0 | 13 | :header-rows: 0 |
diff --git a/Documentation/networking/cdc_mbim.txt b/Documentation/networking/cdc_mbim.txt index e4c376abbdad..4e68f0bc5dba 100644 --- a/Documentation/networking/cdc_mbim.txt +++ b/Documentation/networking/cdc_mbim.txt | |||
@@ -332,8 +332,8 @@ References | |||
332 | [5] "MBIM (Mobile Broadband Interface Model) Registry" | 332 | [5] "MBIM (Mobile Broadband Interface Model) Registry" |
333 | - http://compliance.usb.org/mbim/ | 333 | - http://compliance.usb.org/mbim/ |
334 | 334 | ||
335 | [6] "/dev/bus/usb filesystem output" | 335 | [6] "/sys/kernel/debug/usb/devices output format" |
336 | - Documentation/usb/proc_usb_info.txt | 336 | - Documentation/driver-api/usb/usb.rst |
337 | 337 | ||
338 | [7] "/sys/bus/usb/devices/.../descriptors" | 338 | [7] "/sys/bus/usb/devices/.../descriptors" |
339 | - Documentation/ABI/stable/sysfs-bus-usb | 339 | - Documentation/ABI/stable/sysfs-bus-usb |
diff --git a/Documentation/networking/checksum-offloads.txt b/Documentation/networking/checksum-offloads.txt index d52d191bbb0c..27bc09cfcf6d 100644 --- a/Documentation/networking/checksum-offloads.txt +++ b/Documentation/networking/checksum-offloads.txt | |||
@@ -47,7 +47,7 @@ The requirements for GSO are more complicated, because when segmenting an | |||
47 | (section 'E') for more details. | 47 | (section 'E') for more details. |
48 | 48 | ||
49 | A driver declares its offload capabilities in netdev->hw_features; see | 49 | A driver declares its offload capabilities in netdev->hw_features; see |
50 | Documentation/networking/netdev-features for more. Note that a device | 50 | Documentation/networking/netdev-features.txt for more. Note that a device |
51 | which only advertises NETIF_F_IP[V6]_CSUM must still obey the csum_start | 51 | which only advertises NETIF_F_IP[V6]_CSUM must still obey the csum_start |
52 | and csum_offset given in the SKB; if it tries to deduce these itself in | 52 | and csum_offset given in the SKB; if it tries to deduce these itself in |
53 | hardware (as some NICs do) the driver should check that the values in the | 53 | hardware (as some NICs do) the driver should check that the values in the |
diff --git a/Documentation/networking/packet_mmap.txt b/Documentation/networking/packet_mmap.txt index f3b9e507ab05..bf654845556e 100644 --- a/Documentation/networking/packet_mmap.txt +++ b/Documentation/networking/packet_mmap.txt | |||
@@ -1055,7 +1055,7 @@ TX_RING part only TP_STATUS_AVAILABLE is set, then the tp_sec and tp_{n,u}sec | |||
1055 | members do not contain a valid value. For TX_RINGs, by default no timestamp | 1055 | members do not contain a valid value. For TX_RINGs, by default no timestamp |
1056 | is generated! | 1056 | is generated! |
1057 | 1057 | ||
1058 | See include/linux/net_tstamp.h and Documentation/networking/timestamping | 1058 | See include/linux/net_tstamp.h and Documentation/networking/timestamping.txt |
1059 | for more information on hardware timestamps. | 1059 | for more information on hardware timestamps. |
1060 | 1060 | ||
1061 | ------------------------------------------------------------------------------- | 1061 | ------------------------------------------------------------------------------- |
diff --git a/Documentation/power/interface.txt b/Documentation/power/interface.txt index 974916ff6608..7dc75f48e8bd 100644 --- a/Documentation/power/interface.txt +++ b/Documentation/power/interface.txt | |||
@@ -24,7 +24,8 @@ platform. | |||
24 | 24 | ||
25 | If one of the strings listed in /sys/power/state is written to it, the system | 25 | If one of the strings listed in /sys/power/state is written to it, the system |
26 | will attempt to transition into the corresponding sleep state. Refer to | 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 | /sys/power/disk controls the operating mode of hibernation (Suspend-to-Disk). | 30 | /sys/power/disk controls the operating mode of hibernation (Suspend-to-Disk). |
30 | Specifically, it tells the kernel what to do after creating a hibernation image. | 31 | Specifically, it tells the kernel what to do after creating a hibernation image. |
diff --git a/Documentation/power/pci.txt b/Documentation/power/pci.txt index a1b7f7158930..d17fdf8f45ef 100644 --- a/Documentation/power/pci.txt +++ b/Documentation/power/pci.txt | |||
@@ -8,7 +8,7 @@ management. Based on previous work by Patrick Mochel <mochel@transmeta.com> | |||
8 | 8 | ||
9 | This document only covers the aspects of power management specific to PCI | 9 | This document only covers the aspects of power management specific to PCI |
10 | devices. For general description of the kernel's interfaces related to device | 10 | devices. For general description of the kernel's interfaces related to device |
11 | power management refer to Documentation/power/admin-guide/devices.rst and | 11 | power management refer to Documentation/driver-api/pm/devices.rst and |
12 | Documentation/power/runtime_pm.txt. | 12 | Documentation/power/runtime_pm.txt. |
13 | 13 | ||
14 | --------------------------------------------------------------------------- | 14 | --------------------------------------------------------------------------- |
@@ -417,7 +417,7 @@ pm->runtime_idle() callback. | |||
417 | 2.4. System-Wide Power Transitions | 417 | 2.4. System-Wide Power Transitions |
418 | ---------------------------------- | 418 | ---------------------------------- |
419 | There are a few different types of system-wide power transitions, described in | 419 | There are a few different types of system-wide power transitions, described in |
420 | Documentation/power/admin-guide/devices.rst. Each of them requires devices to be handled | 420 | Documentation/driver-api/pm/devices.rst. Each of them requires devices to be handled |
421 | in a specific way and the PM core executes subsystem-level power management | 421 | in a specific way and the PM core executes subsystem-level power management |
422 | callbacks for this purpose. They are executed in phases such that each phase | 422 | callbacks for this purpose. They are executed in phases such that each phase |
423 | involves executing the same subsystem-level callback for every device belonging | 423 | involves executing the same subsystem-level callback for every device belonging |
@@ -623,7 +623,7 @@ System restore requires a hibernation image to be loaded into memory and the | |||
623 | pre-hibernation memory contents to be restored before the pre-hibernation system | 623 | pre-hibernation memory contents to be restored before the pre-hibernation system |
624 | activity can be resumed. | 624 | activity can be resumed. |
625 | 625 | ||
626 | As described in Documentation/power/admin-guide/devices.rst, the hibernation image is loaded | 626 | As described in Documentation/driver-api/pm/devices.rst, the hibernation image is loaded |
627 | into memory by a fresh instance of the kernel, called the boot kernel, which in | 627 | into memory by a fresh instance of the kernel, called the boot kernel, which in |
628 | turn is loaded and run by a boot loader in the usual way. After the boot kernel | 628 | turn is loaded and run by a boot loader in the usual way. After the boot kernel |
629 | has loaded the image, it needs to replace its own code and data with the code | 629 | has loaded the image, it needs to replace its own code and data with the code |
@@ -677,7 +677,7 @@ controlling the runtime power management of their devices. | |||
677 | 677 | ||
678 | At the time of this writing there are two ways to define power management | 678 | At the time of this writing there are two ways to define power management |
679 | callbacks for a PCI device driver, the recommended one, based on using a | 679 | callbacks for a PCI device driver, the recommended one, based on using a |
680 | dev_pm_ops structure described in Documentation/power/admin-guide/devices.rst, and the | 680 | dev_pm_ops structure described in Documentation/driver-api/pm/devices.rst, and the |
681 | "legacy" one, in which the .suspend(), .suspend_late(), .resume_early(), and | 681 | "legacy" one, in which the .suspend(), .suspend_late(), .resume_early(), and |
682 | .resume() callbacks from struct pci_driver are used. The legacy approach, | 682 | .resume() callbacks from struct pci_driver are used. The legacy approach, |
683 | however, doesn't allow one to define runtime power management callbacks and is | 683 | however, doesn't allow one to define runtime power management callbacks and is |
@@ -1046,5 +1046,5 @@ PCI Local Bus Specification, Rev. 3.0 | |||
1046 | PCI Bus Power Management Interface Specification, Rev. 1.2 | 1046 | PCI Bus Power Management Interface Specification, Rev. 1.2 |
1047 | Advanced Configuration and Power Interface (ACPI) Specification, Rev. 3.0b | 1047 | Advanced Configuration and Power Interface (ACPI) Specification, Rev. 3.0b |
1048 | PCI Express Base Specification, Rev. 2.0 | 1048 | PCI Express Base Specification, Rev. 2.0 |
1049 | Documentation/power/admin-guide/devices.rst | 1049 | Documentation/driver-api/pm/devices.rst |
1050 | Documentation/power/runtime_pm.txt | 1050 | Documentation/power/runtime_pm.txt |
diff --git a/Documentation/power/runtime_pm.txt b/Documentation/power/runtime_pm.txt index 625549d4c74a..57af2f7963ee 100644 --- a/Documentation/power/runtime_pm.txt +++ b/Documentation/power/runtime_pm.txt | |||
@@ -680,7 +680,7 @@ left in runtime suspend. If that happens, the PM core will not execute any | |||
680 | system suspend and resume callbacks for all of those devices, except for the | 680 | system suspend and resume callbacks for all of those devices, except for the |
681 | complete callback, which is then entirely responsible for handling the device | 681 | complete callback, which is then entirely responsible for handling the device |
682 | as appropriate. This only applies to system suspend transitions that are not | 682 | as appropriate. This only applies to system suspend transitions that are not |
683 | related to hibernation (see Documentation/power/admin-guide/devices.rst for more | 683 | related to hibernation (see Documentation/driver-api/pm/devices.rst for more |
684 | information). | 684 | information). |
685 | 685 | ||
686 | The PM core does its best to reduce the probability of race conditions between | 686 | The PM core does its best to reduce the probability of race conditions between |
diff --git a/Documentation/process/submitting-drivers.rst b/Documentation/process/submitting-drivers.rst index afb82ee0cbea..b38bf2054ce3 100644 --- a/Documentation/process/submitting-drivers.rst +++ b/Documentation/process/submitting-drivers.rst | |||
@@ -117,7 +117,7 @@ PM support: | |||
117 | anything. For the driver testing instructions see | 117 | anything. For the driver testing instructions see |
118 | Documentation/power/drivers-testing.txt and for a relatively | 118 | Documentation/power/drivers-testing.txt and for a relatively |
119 | complete overview of the power management issues related to | 119 | complete overview of the power management issues related to |
120 | drivers see Documentation/power/admin-guide/devices.rst . | 120 | drivers see Documentation/driver-api/pm/devices.rst. |
121 | 121 | ||
122 | Control: | 122 | Control: |
123 | In general if there is active maintenance of a driver by | 123 | In general if there is active maintenance of a driver by |
diff --git a/Documentation/security/LSM.rst b/Documentation/security/LSM.rst index d75778b0fa10..98522e0e1ee2 100644 --- a/Documentation/security/LSM.rst +++ b/Documentation/security/LSM.rst | |||
@@ -5,7 +5,7 @@ Linux Security Module Development | |||
5 | Based on https://lkml.org/lkml/2007/10/26/215, | 5 | Based on https://lkml.org/lkml/2007/10/26/215, |
6 | a new LSM is accepted into the kernel when its intent (a description of | 6 | a new LSM is accepted into the kernel when its intent (a description of |
7 | what it tries to protect against and in what cases one would expect to | 7 | what it tries to protect against and in what cases one would expect to |
8 | use it) has been appropriately documented in ``Documentation/security/LSM``. | 8 | use it) has been appropriately documented in ``Documentation/security/LSM.rst``. |
9 | This allows an LSM's code to be easily compared to its goals, and so | 9 | This allows an LSM's code to be easily compared to its goals, and so |
10 | that end users and distros can make a more informed decision about which | 10 | that end users and distros can make a more informed decision about which |
11 | LSMs suit their requirements. | 11 | LSMs suit their requirements. |
diff --git a/Documentation/security/credentials.rst b/Documentation/security/credentials.rst index 038a7e19eff9..66a2e24939d8 100644 --- a/Documentation/security/credentials.rst +++ b/Documentation/security/credentials.rst | |||
@@ -196,7 +196,7 @@ The Linux kernel supports the following types of credentials: | |||
196 | When a process accesses a key, if not already present, it will normally be | 196 | When a process accesses a key, if not already present, it will normally be |
197 | cached on one of these keyrings for future accesses to find. | 197 | cached on one of these keyrings for future accesses to find. |
198 | 198 | ||
199 | For more information on using keys, see Documentation/security/keys.txt. | 199 | For more information on using keys, see ``Documentation/security/keys/*``. |
200 | 200 | ||
201 | 5. LSM | 201 | 5. LSM |
202 | 202 | ||
diff --git a/Documentation/security/keys/request-key.rst b/Documentation/security/keys/request-key.rst index b2d16abaa9e9..21e27238cec6 100644 --- a/Documentation/security/keys/request-key.rst +++ b/Documentation/security/keys/request-key.rst | |||
@@ -3,7 +3,7 @@ Key Request Service | |||
3 | =================== | 3 | =================== |
4 | 4 | ||
5 | The key request service is part of the key retention service (refer to | 5 | The key request service is part of the key retention service (refer to |
6 | Documentation/security/core.rst). This document explains more fully how | 6 | Documentation/security/keys/core.rst). This document explains more fully how |
7 | the requesting algorithm works. | 7 | the requesting algorithm works. |
8 | 8 | ||
9 | The process starts by either the kernel requesting a service by calling | 9 | The process starts by either the kernel requesting a service by calling |
diff --git a/Documentation/sound/cards/joystick.rst b/Documentation/sound/cards/joystick.rst index a6e468c81d02..488946fc1079 100644 --- a/Documentation/sound/cards/joystick.rst +++ b/Documentation/sound/cards/joystick.rst | |||
@@ -11,7 +11,7 @@ General | |||
11 | 11 | ||
12 | First of all, you need to enable GAMEPORT support on Linux kernel for | 12 | First of all, you need to enable GAMEPORT support on Linux kernel for |
13 | using a joystick with the ALSA driver. For the details of gameport | 13 | using a joystick with the ALSA driver. For the details of gameport |
14 | support, refer to Documentation/input/joystick.txt. | 14 | support, refer to Documentation/input/joydev/joystick.rst. |
15 | 15 | ||
16 | The joystick support of ALSA drivers is different between ISA and PCI | 16 | The joystick support of ALSA drivers is different between ISA and PCI |
17 | cards. In the case of ISA (PnP) cards, it's usually handled by the | 17 | cards. In the case of ISA (PnP) cards, it's usually handled by the |
diff --git a/Documentation/sound/hd-audio/notes.rst b/Documentation/sound/hd-audio/notes.rst index f59c3cdbfaf4..9f7347830ba4 100644 --- a/Documentation/sound/hd-audio/notes.rst +++ b/Documentation/sound/hd-audio/notes.rst | |||
@@ -192,7 +192,7 @@ preset model instead of PCI (and codec-) SSID look-up. | |||
192 | What ``model`` option values are available depends on the codec chip. | 192 | What ``model`` option values are available depends on the codec chip. |
193 | Check your codec chip from the codec proc file (see "Codec Proc-File" | 193 | Check your codec chip from the codec proc file (see "Codec Proc-File" |
194 | section below). It will show the vendor/product name of your codec | 194 | section below). It will show the vendor/product name of your codec |
195 | chip. Then, see Documentation/sound/HD-Audio-Models.rst file, | 195 | chip. Then, see Documentation/sound/hd-audio/models.rst file, |
196 | the section of HD-audio driver. You can find a list of codecs | 196 | the section of HD-audio driver. You can find a list of codecs |
197 | and ``model`` options belonging to each codec. For example, for Realtek | 197 | and ``model`` options belonging to each codec. For example, for Realtek |
198 | ALC262 codec chip, pass ``model=ultra`` for devices that are compatible | 198 | ALC262 codec chip, pass ``model=ultra`` for devices that are compatible |
diff --git a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst index 58ffa3f5bda7..a0b268466cb1 100644 --- a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst +++ b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst | |||
@@ -2498,7 +2498,7 @@ Mic boost | |||
2498 | Mic-boost switch is set as “Mic Boost” or “Mic Boost (6dB)”. | 2498 | Mic-boost switch is set as “Mic Boost” or “Mic Boost (6dB)”. |
2499 | 2499 | ||
2500 | More precise information can be found in | 2500 | More precise information can be found in |
2501 | ``Documentation/sound/alsa/ControlNames.txt``. | 2501 | ``Documentation/sound/designs/control-names.rst``. |
2502 | 2502 | ||
2503 | Access Flags | 2503 | Access Flags |
2504 | ------------ | 2504 | ------------ |
diff --git a/Documentation/usb/gadget-testing.txt b/Documentation/usb/gadget-testing.txt index fbc397d17e98..441a4b9b666f 100644 --- a/Documentation/usb/gadget-testing.txt +++ b/Documentation/usb/gadget-testing.txt | |||
@@ -773,7 +773,7 @@ host: | |||
773 | # cat /dev/usb/lp0 | 773 | # cat /dev/usb/lp0 |
774 | 774 | ||
775 | More advanced testing can be done with the prn_example | 775 | More advanced testing can be done with the prn_example |
776 | described in Documentation/usb/gadget-printer.txt. | 776 | described in Documentation/usb/gadget_printer.txt. |
777 | 777 | ||
778 | 778 | ||
779 | 20. UAC1 function (virtual ALSA card, using u_audio API) | 779 | 20. UAC1 function (virtual ALSA card, using u_audio API) |