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

docs: fix locations of several documents that got moved

The previous patch renamed several files that are cross-referenced
along the Kernel documentation. Adjust the links to point to
the right places.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

+280 -278
+27 -27
Documentation/00-INDEX
··· 15 15 ABI/ 16 16 - info on kernel <-> userspace ABI and relative interface stability. 17 17 18 - BUG-HUNTING 18 + admin-guide/bug-hunting.rst 19 19 - brute force method of doing binary search of patches to find bug. 20 - Changes 20 + process/changes.rst 21 21 - list of changes that break older software packages. 22 - CodingStyle 22 + process/coding-style.rst 23 23 - how the maintainers expect the C code in the kernel to look. 24 24 DMA-API.txt 25 25 - DMA API, pci_ API & extensions for non-consistent memory machines. ··· 33 33 - directory with DocBook templates etc. for kernel documentation. 34 34 EDID/ 35 35 - directory with info on customizing EDID for broken gfx/displays. 36 - HOWTO 36 + process/howto.rst 37 37 - the process and procedures of how to do Linux kernel development. 38 38 IPMI.txt 39 39 - info on Linux Intelligent Platform Management Interface (IPMI) Driver. ··· 48 48 Makefile 49 49 - This file does nothing. Removing it breaks make htmldocs and 50 50 make distclean. 51 - ManagementStyle 51 + process/management-style.rst 52 52 - how to (attempt to) manage kernel hackers. 53 53 RCU/ 54 54 - directory with info on RCU (read-copy update). ··· 56 56 - info on Secure Attention Keys. 57 57 SM501.txt 58 58 - Silicon Motion SM501 multimedia companion chip 59 - SecurityBugs 59 + admin-guide/security-bugs.rst 60 60 - procedure for reporting security bugs found in the kernel. 61 - SubmitChecklist 61 + process/submit-checklist.rst 62 62 - Linux kernel patch submission checklist. 63 - SubmittingDrivers 63 + process/submitting-drivers.rst 64 64 - procedure to get a new driver source included into the kernel tree. 65 - SubmittingPatches 65 + process/submitting-patches.rst 66 66 - procedure to get a source patch included into the kernel tree. 67 67 VGA-softcursor.txt 68 68 - how to change your VGA cursor from a blinking underscore. ··· 72 72 - info on ACPI-specific hooks in the kernel. 73 73 aoe/ 74 74 - description of AoE (ATA over Ethernet) along with config examples. 75 - applying-patches.txt 75 + process/applying-patches.rst 76 76 - description of various trees and how to apply their patches. 77 77 arm/ 78 78 - directory with info about Linux on the ARM architecture. ··· 86 86 - misc. LCD driver documentation (cfag12864b, ks0108). 87 87 backlight/ 88 88 - directory with info on controlling backlights in flat panel displays 89 - bad_memory.txt 89 + admin-guide/bad-memory.rst 90 90 - how to use kernel parameters to exclude bad RAM regions. 91 91 basic_profiling.txt 92 92 - basic instructions for those who wants to profile Linux kernel. ··· 154 154 - how to work with the mainline kernel development process. 155 155 device-mapper/ 156 156 - directory with info on Device Mapper. 157 - devices.txt 157 + admin-guide/devices.rst 158 158 - plain ASCII listing of all the nodes in /dev/ with major minor #'s. 159 159 devicetree/ 160 160 - directory with info on device tree files used by OF/PowerPC/ARM ··· 178 178 - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems. 179 179 eisa.txt 180 180 - info on EISA bus support. 181 - email-clients.txt 181 + process/email-clients.rst 182 182 - info on how to use e-mail to send un-mangled (git) patches. 183 183 extcon/ 184 184 - directory with porting guide for Android kernel switch driver. ··· 226 226 - directory with info about Linux on Intel 64 bit architecture. 227 227 infiniband/ 228 228 - directory with documents concerning Linux InfiniBand support. 229 - init.txt 229 + admin-guide/init.rst 230 230 - what to do when the kernel can't find the 1st process to run. 231 - initrd.txt 231 + admin-guide/initrd.rst 232 232 - how to use the RAM disk as an initial/temporary root filesystem. 233 233 input/ 234 234 - info on Linux input device support. ··· 248 248 - info on Linux ISA Plug & Play support. 249 249 isdn/ 250 250 - directory with info on the Linux ISDN support, and supported cards. 251 - java.txt 251 + admin-guide/java.rst 252 252 - info on the in-kernel binary support for Java(tm). 253 253 ja_JP/ 254 254 - directory with Japanese translations of various documents ··· 256 256 - directory with info about the kernel build process. 257 257 kdump/ 258 258 - directory with mini HowTo on getting the crash dump code to work. 259 - kernel-docs.txt 259 + process/kernel-docs.rst 260 260 - listing of various WWW + books that document kernel internals. 261 261 kernel-documentation.rst 262 262 - how to write and format reStructuredText kernel documentation 263 - kernel-parameters.txt 263 + admin-guide/kernel-parameters.rst 264 264 - summary listing of command line / boot prompt args for the kernel. 265 265 kernel-per-CPU-kthreads.txt 266 266 - List of all per-CPU kthreads and how they introduce jitter. ··· 302 302 - list of magic numbers used to mark/protect kernel data structures. 303 303 mailbox.txt 304 304 - How to write drivers for the common mailbox framework (IPC). 305 - md.txt 305 + admin-guide/md.rst 306 306 - info on boot arguments for the multiple devices driver. 307 307 media-framework.txt 308 308 - info on media framework, its data structures, functions and usage. ··· 326 326 - Kernel module signing for increased security when loading modules. 327 327 mtd/ 328 328 - directory with info about memory technology devices (flash) 329 - mono.txt 329 + admin-guide/mono.rst 330 330 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC. 331 331 namespaces/ 332 332 - directory with various information about namespaces ··· 340 340 - documentation about no-mmu memory mapping support. 341 341 numastat.txt 342 342 - info on how to read Numa policy hit/miss statistics in sysfs. 343 - oops-tracing.txt 343 + admin-guide/oops-tracing.rst 344 344 - how to decode those nasty internal kernel error dump messages. 345 345 padata.txt 346 346 - An introduction to the "padata" parallel execution API ··· 378 378 - directory with info on support for IEEE 1588 PTP clocks in Linux. 379 379 pwm.txt 380 380 - info on the pulse width modulation driver subsystem 381 - ramoops.txt 381 + admin-guide/ramoops.rst 382 382 - documentation of the ramoops oops/panic logging module. 383 383 rapidio/ 384 384 - directory with info on RapidIO packet-based fabric interconnect ··· 406 406 - directory that contains security-related info 407 407 serial/ 408 408 - directory with info on the low level serial API. 409 - serial-console.txt 409 + admin-guide/serial-console.rst 410 410 - how to set up Linux with a serial line console as the default. 411 411 sgi-ioc4.txt 412 412 - description of the SGI IOC4 PCI (multi function) device. ··· 420 420 - info on how to obtain and use the sparse tool for typechecking. 421 421 spi/ 422 422 - overview of Linux kernel Serial Peripheral Interface (SPI) support. 423 - stable_api_nonsense.txt 423 + process/stable-api-nonsense.rst 424 424 - info on why the kernel does not have a stable in-kernel api or abi. 425 - stable_kernel_rules.txt 425 + process/stable-kernel-rules.rst 426 426 - rules and procedures for the -stable kernel releases. 427 427 static-keys.txt 428 428 - info on how static keys allow debug code in hotpaths via patching ··· 444 444 - directory with info on tracing technologies within linux 445 445 unaligned-memory-access.txt 446 446 - info on how to avoid arch breaking unaligned memory access in code. 447 - unicode.txt 447 + admin-guide/unicode.rst 448 448 - info on the Unicode character/font mapping used in Linux. 449 449 unshare.txt 450 450 - description of the Linux unshare system call. ··· 466 466 - directory with info on the Linux vm code. 467 467 vme_api.txt 468 468 - file relating info on the VME bus API in linux 469 - volatile-considered-harmful.txt 469 + process/volatile-considered-harmful.rst 470 470 - Why the "volatile" type class should not be used 471 471 w1/ 472 472 - directory with documents regarding the 1-wire (w1) subsystem.
+1 -1
Documentation/ABI/README
··· 84 84 85 85 - Kernel-internal symbols. Do not rely on the presence, absence, location, or 86 86 type of any kernel symbol, either in System.map files or the kernel binary 87 - itself. See Documentation/stable_api_nonsense.txt. 87 + itself. See Documentation/process/stable-api-nonsense.rst.
+1 -1
Documentation/ABI/testing/sysfs-kernel-slab
··· 347 347 because of fragmentation, SLUB will retry with the minimum order 348 348 possible depending on its characteristics. 349 349 When debug_guardpage_minorder=N (N > 0) parameter is specified 350 - (see Documentation/kernel-parameters.txt), the minimum possible 350 + (see Documentation/admin-guide/kernel-parameters.rst), the minimum possible 351 351 order is used and this sysfs entry can not be used to change 352 352 the order at run time. 353 353
+2 -2
Documentation/DocBook/kernel-hacking.tmpl
··· 1208 1208 1209 1209 <listitem> 1210 1210 <para> 1211 - Finally, don't forget to read <filename>Documentation/SubmittingPatches</filename> 1212 - and possibly <filename>Documentation/SubmittingDrivers</filename>. 1211 + Finally, don't forget to read <filename>Documentation/process/submitting-patches.rst</filename> 1212 + and possibly <filename>Documentation/process/submitting-drivers.rst</filename>. 1213 1213 </para> 1214 1214 </listitem> 1215 1215 </itemizedlist>
+1 -1
Documentation/acpi/video_extension.txt
··· 101 101 not affect the sending of event to user space, they are always sent to user 102 102 space regardless of whether or not the video module controls the backlight level 103 103 directly. This behaviour can be controlled through the brightness_switch_enabled 104 - module parameter as documented in kernel-parameters.txt. It is recommended to 104 + module parameter as documented in admin-guide/kernel-parameters.rst. It is recommended to 105 105 disable this behaviour once a GUI environment starts up and wants to have full 106 106 control of the backlight level.
+7 -6
Documentation/admin-guide/README.rst
··· 50 50 - There are various README files in the Documentation/ subdirectory: 51 51 these typically contain kernel-specific installation notes for some 52 52 drivers for example. See Documentation/00-INDEX for a list of what 53 - is contained in each file. Please read the Changes file, as it 53 + is contained in each file. Please read the 54 + :ref:`Documentation/process/changes.rst <changes>` file, as it 54 55 contains information about the problems, which may result by upgrading 55 56 your kernel. 56 57 ··· 97 96 and 4.0.2 patches. Similarly, if you are running kernel version 4.0.2 and 98 97 want to jump to 4.0.3, you must first reverse the 4.0.2 patch (that is, 99 98 patch -R) **before** applying the 4.0.3 patch. You can read more on this in 100 - :ref:`Documentation/applying-patches.txt <applying_patches>`. 99 + :ref:`Documentation/process/applying-patches.rst <applying_patches>`. 101 100 102 101 Alternatively, the script patch-kernel can be used to automate this 103 102 process. It determines the current kernel version and applies any ··· 121 120 122 121 Compiling and running the 4.x kernels requires up-to-date 123 122 versions of various software packages. Consult 124 - :ref:`Documentation/Changes <changes>` for the minimum version numbers 123 + :ref:`Documentation/process/changes.rst <changes>` for the minimum version numbers 125 124 required and how to get updates for these packages. Beware that using 126 125 excessively old versions of these packages can cause indirect 127 126 errors that are very difficult to track down, so don't assume that ··· 255 254 -------------------- 256 255 257 256 - Make sure you have at least gcc 3.2 available. 258 - For more information, refer to :ref:`Documentation/Changes <changes>`. 257 + For more information, refer to :ref:`Documentation/process/changes.rst <changes>`. 259 258 260 259 Please note that you can still run a.out user programs with this kernel. 261 260 ··· 356 355 help debugging the problem. The text above the dump is also 357 356 important: it tells something about why the kernel dumped code (in 358 357 the above example, it's due to a bad kernel pointer). More information 359 - on making sense of the dump is in Documentation/oops-tracing.txt 358 + on making sense of the dump is in Documentation/admin-guide/oops-tracing.rst 360 359 361 360 - If you compiled the kernel with CONFIG_KALLSYMS you can send the dump 362 361 as is, otherwise you will have to use the ``ksymoops`` program to make ··· 394 393 395 394 If you for some reason cannot do the above (you have a pre-compiled 396 395 kernel image or similar), telling me as much about your setup as 397 - possible will help. Please read the :ref:`REPORTING-BUGS <reportingbugs>` 396 + possible will help. Please read the :ref:`admin-guide/reporting-bugs.rst <reportingbugs>` 398 397 document for details. 399 398 400 399 - Alternatively, you can use gdb on a running kernel. (read-only; i.e. you
+1 -1
Documentation/admin-guide/bad-memory.rst
··· 33 33 boot-time. Its syntax is slightly strange and you may need to 34 34 calculate the values by yourself! 35 35 36 - Syntax to exclude a memory area (see kernel-parameters.txt for details):: 36 + Syntax to exclude a memory area (see admin-guide/kernel-parameters.rst for details):: 37 37 38 38 memmap=<size>$<address> 39 39
+2 -2
Documentation/admin-guide/binfmt-misc.rst
··· 124 124 125 125 echo ':DOSWin:M::MZ::/usr/local/bin/wine:' > register 126 126 127 - For java support see Documentation/java.txt 127 + For java support see Documentation/admin-guide/java.rst 128 128 129 129 130 130 You can enable/disable binfmt_misc or one binary type by echoing 0 (to disable) ··· 140 140 ----- 141 141 142 142 If you want to pass special arguments to your interpreter, you can 143 - write a wrapper script for it. See Documentation/java.txt for an 143 + write a wrapper script for it. See Documentation/admin-guide/java.rst for an 144 144 example. 145 145 146 146 Your interpreter should NOT look in the PATH for the filename; the kernel
+3 -3
Documentation/admin-guide/braille-console.rst
··· 3 3 4 4 To get early boot messages on a braille device (before userspace screen 5 5 readers can start), you first need to compile the support for the usual serial 6 - console (see :ref:`Documentation/serial-console.txt <serial_console>`), and 6 + console (see :ref:`Documentation/admin-guide/serial-console.rst <serial_console>`), and 7 7 for braille device 8 8 (in :menuselection:`Device Drivers --> Accessibility support --> Console on braille device`). 9 9 ··· 13 13 console=brl,serial_options... 14 14 15 15 where ``serial_options...`` are the same as described in 16 - :ref:`Documentation/serial-console.txt <serial_console>`. 16 + :ref:`Documentation/admin-guide/serial-console.rst <serial_console>`. 17 17 18 18 So for instance you can use ``console=brl,ttyS0`` if the braille device is connected to the first serial port, and ``console=brl,ttyS0,115200`` to 19 19 override the baud rate to 115200, etc. ··· 31 31 For simplicity, only one braille console can be enabled, other uses of 32 32 ``console=brl,...`` will be discarded. Also note that it does not interfere with 33 33 the console selection mechanism described in 34 - :ref:`Documentation/serial-console.txt <serial_console>`. 34 + :ref:`Documentation/admin-guide/serial-console.rst <serial_console>`. 35 35 36 36 For now, only the VisioBraille device is supported. 37 37
+4 -3
Documentation/admin-guide/bug-hunting.rst
··· 15 15 MAINTAINERS for who that is for the subsystem you have worked on. 16 16 17 17 Before you submit a bug report read 18 - :ref:`Documentation/REPORTING-BUGS <reportingbugs>`. 18 + :ref:`Documentation/admin-guide/reporting-bugs.rst <reportingbugs>`. 19 19 20 20 Devices not appearing 21 21 ===================== ··· 244 244 source is about sharing what you do and don't you want to be recognised for 245 245 your genius? 246 246 247 - Please do read :ref:`Documentation/SubmittingPatches <submittingpatches>` 248 - though to help your code get accepted. 247 + Please do read 248 + ref:`Documentation/process/submitting-patches.rst <submittingpatches>` though 249 + to help your code get accepted.
+1 -1
Documentation/admin-guide/devices.rst
··· 10 10 the document that used to reside at lanana.org. This version in the 11 11 mainline Linux kernel is the master document. Updates shall be sent 12 12 as patches to the kernel maintainers (see the 13 - :ref:`Documentation/SubmittingPatches <submittingpatches>` document). 13 + :ref:`Documentation/process/submitting-patches.rst <submittingpatches>` document). 14 14 Specifically explore the sections titled "CHAR and MISC DRIVERS", and 15 15 "BLOCK LAYER" in the MAINTAINERS file to find the right maintainers 16 16 to involve for character and block devices.
+3 -3
Documentation/admin-guide/kernel-parameters.rst
··· 815 815 bits, and "f" is flow control ("r" for RTS or 816 816 omit it). Default is "9600n8". 817 817 818 - See Documentation/serial-console.txt for more 818 + See Documentation/admin-guide/serial-console.rst for more 819 819 information. See 820 820 Documentation/networking/netconsole.txt for an 821 821 alternative. ··· 2239 2239 mce=option [X86-64] See Documentation/x86/x86_64/boot-options.txt 2240 2240 2241 2241 md= [HW] RAID subsystems devices and level 2242 - See Documentation/md.txt. 2242 + See Documentation/admin-guide/md.rst. 2243 2243 2244 2244 mdacon= [MDA] 2245 2245 Format: <first>,<last> ··· 3322 3322 r128= [HW,DRM] 3323 3323 3324 3324 raid= [HW,RAID] 3325 - See Documentation/md.txt. 3325 + See Documentation/admin-guide/md.rst. 3326 3326 3327 3327 ramdisk_size= [RAM] Sizes of RAM disks in kilobytes 3328 3328 See Documentation/blockdev/ramdisk.txt.
+1 -1
Documentation/admin-guide/oops-tracing.rst
··· 44 44 so won't help for 'early' oopses) 45 45 46 46 (2) Boot with a serial console (see 47 - :ref:`Documentation/serial-console.txt <serial_console>`), 47 + :ref:`Documentation/admin-guide/serial-console.rst <serial_console>`), 48 48 run a null modem to a second machine and capture the output there 49 49 using your favourite communication program. Minicom works well. 50 50
+1 -1
Documentation/admin-guide/ramoops.rst
··· 61 61 mem=128M ramoops.mem_address=0x8000000 ramoops.ecc=1 62 62 63 63 B. Use Device Tree bindings, as described in 64 - ``Documentation/device-tree/bindings/reserved-memory/ramoops.txt``. 64 + ``Documentation/device-tree/bindings/reserved-memory/admin-guide/ramoops.rst``. 65 65 For example:: 66 66 67 67 reserved-memory {
+3 -3
Documentation/admin-guide/reporting-bugs.rst
··· 61 61 62 62 If it is a security bug, please copy the Security Contact listed in the 63 63 MAINTAINERS file. They can help coordinate bugfix and disclosure. See 64 - :ref:`Documentation/SecurityBugs <securitybugs>` for more information. 64 + :ref:`Documentation/admin-guide/security-bugs.rst <securitybugs>` for more information. 65 65 66 66 If you can't figure out which subsystem caused the issue, you should file 67 67 a bug in kernel.org bugzilla and send email to ··· 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/oops-tracing.txt" before posting your 97 + report. Please read "Documentation/admin-guide/oops-tracing.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/oops-tracing.txt) 123 + resolved (see Documentation/admin-guide/oops-tracing.rst) 124 124 [7.] A small shell script or example program which triggers the 125 125 problem (if possible) 126 126 [8.] Environment
+1 -1
Documentation/admin-guide/security-bugs.rst
··· 19 19 20 20 As it is with any bug, the more information provided the easier it 21 21 will be to diagnose and fix. Please review the procedure outlined in 22 - REPORTING-BUGS if you are unclear about what information is helpful. 22 + admin-guide/reporting-bugs.rst if you are unclear about what information is helpful. 23 23 Any exploit code is very helpful and will not be released without 24 24 consent from the reporter unless it has already been made public. 25 25
+1 -1
Documentation/admin-guide/unicode.rst
··· 7 7 of the Linux Assigned Names And Numbers Authority (LANANA) project. 8 8 The current version can be found at: 9 9 10 - http://www.lanana.org/docs/unicode/unicode.txt 10 + http://www.lanana.org/docs/unicode/admin-guide/unicode.rst 11 11 12 12 Introdution 13 13 -----------
+1 -1
Documentation/arm/Booting
··· 51 51 option to the kernel via the tagged lists specifying the port, and 52 52 serial format options as described in 53 53 54 - Documentation/kernel-parameters.txt. 54 + Documentation/admin-guide/kernel-parameters.rst. 55 55 56 56 57 57 3. Detect the machine type
+1 -1
Documentation/atomic_ops.txt
··· 16 16 typedef struct { long counter; } atomic_long_t; 17 17 18 18 Historically, counter has been declared volatile. This is now discouraged. 19 - See Documentation/volatile-considered-harmful.txt for the complete rationale. 19 + See Documentation/process/volatile-considered-harmful.rst for the complete rationale. 20 20 21 21 local_t is very similar to atomic_t. If the counter is per CPU and only 22 22 updated by one CPU, local_t is probably more appropriate. Please see
+1 -1
Documentation/blockdev/ramdisk.txt
··· 14 14 15 15 The RAM disk driver is a way to use main system memory as a block device. It 16 16 is required for initrd, an initial filesystem used if you need to load modules 17 - in order to access the root filesystem (see Documentation/initrd.txt). It can 17 + in order to access the root filesystem (see Documentation/admin-guide/initrd.rst). It can 18 18 also be used for a temporary filesystem for crypto work, since the contents 19 19 are erased on reboot. 20 20
+1 -1
Documentation/cgroup-v1/00-INDEX
··· 8 8 - CPU Accounting Controller; account CPU usage for groups of tasks. 9 9 cpusets.txt 10 10 - documents the cpusets feature; assign CPUs and Mem to a set of tasks. 11 - devices.txt 11 + admin-guide/devices.rst 12 12 - Device Whitelist Controller; description, interface and security. 13 13 freezer-subsystem.txt 14 14 - checkpointing; rationale to not use signals, interface.
+1 -1
Documentation/devicetree/bindings/rtc/maxim,ds3231.txt
··· 1 1 * Maxim DS3231 Real Time Clock 2 2 3 3 Required properties: 4 - see: Documentation/devicetree/bindings/i2c/trivial-devices.txt 4 + see: Documentation/devicetree/bindings/i2c/trivial-admin-guide/devices.rst 5 5 6 6 Optional property: 7 7 - #clock-cells: Should be 1.
+1 -1
Documentation/devicetree/bindings/rtc/pcf8563.txt
··· 3 3 Philips PCF8563/Epson RTC8564 Real Time Clock 4 4 5 5 Required properties: 6 - see: Documentation/devicetree/bindings/i2c/trivial-devices.txt 6 + see: Documentation/devicetree/bindings/i2c/trivial-admin-guide/devices.rst 7 7 8 8 Optional property: 9 9 - #clock-cells: Should be 0.
+1 -1
Documentation/devicetree/bindings/submitting-patches.txt
··· 3 3 4 4 I. For patch submitters 5 5 6 - 0) Normal patch submission rules from Documentation/SubmittingPatches 6 + 0) Normal patch submission rules from Documentation/process/submitting-patches.rst 7 7 applies. 8 8 9 9 1) The Documentation/ portion of the patch should be a separate patch.
+1 -1
Documentation/filesystems/locks.txt
··· 19 19 20 20 This should not cause problems for anybody, since everybody using a 21 21 2.1.x kernel should have updated their C library to a suitable version 22 - anyway (see the file "Documentation/Changes".) 22 + anyway (see the file "Documentation/process/changes.rst".) 23 23 24 24 1.2 Allow Mixed Locks Again 25 25 ---------------------------
+2 -2
Documentation/filesystems/nfs/nfsroot.txt
··· 11 11 In order to use a diskless system, such as an X-terminal or printer server 12 12 for example, it is necessary for the root filesystem to be present on a 13 13 non-disk device. This may be an initramfs (see Documentation/filesystems/ 14 - ramfs-rootfs-initramfs.txt), a ramdisk (see Documentation/initrd.txt) or a 14 + ramfs-rootfs-initramfs.txt), a ramdisk (see Documentation/admin-guide/initrd.rst) or a 15 15 filesystem mounted via NFS. The following text describes on how to use NFS 16 16 for the root filesystem. For the rest of this text 'client' means the 17 17 diskless system, and 'server' means the NFS server. ··· 284 284 "kernel <relative-path-below /tftpboot>". The nfsroot parameters 285 285 are passed to the kernel by adding them to the "append" line. 286 286 It is common to use serial console in conjunction with pxeliunx, 287 - see Documentation/serial-console.txt for more information. 287 + see Documentation/admin-guide/serial-console.rst for more information. 288 288 289 289 For more information on isolinux, including how to create bootdisks 290 290 for prebuilt kernels, see http://syslinux.zytor.com/
+1 -1
Documentation/frv/booting.txt
··· 119 119 253:0 Device with major 253 and minor 0 120 120 121 121 Authoritative information can be found in 122 - "Documentation/kernel-parameters.txt". 122 + "Documentation/admin-guide/kernel-parameters.rst". 123 123 124 124 (*) rw 125 125
+4 -4
Documentation/hwmon/submitting-patches
··· 10 10 ---------- 11 11 12 12 * It should be unnecessary to mention, but please read and follow 13 - Documentation/SubmitChecklist 14 - Documentation/SubmittingDrivers 15 - Documentation/SubmittingPatches 16 - Documentation/CodingStyle 13 + Documentation/process/submit-checklist.rst 14 + Documentation/process/submitting-drivers.rst 15 + Documentation/process/submitting-patches.rst 16 + Documentation/process/coding-style.rst 17 17 18 18 * Please run your patch through 'checkpatch --strict'. There should be no 19 19 errors, no warnings, and few if any check messages. If there are any
+1 -1
Documentation/isdn/README
··· 332 332 4. Device-inodes 333 333 334 334 The major and minor numbers and their names are described in 335 - Documentation/devices.txt. The major numbers are: 335 + Documentation/admin-guide/devices.rst. The major numbers are: 336 336 337 337 43 for the ISDN-tty's. 338 338 44 for the ISDN-callout-tty's.
+12 -12
Documentation/ja_JP/HOWTO
··· 127 127 小限のレベルで必要な数々のソフトウェアパッケージの一覧を示してい 128 128 ます。 129 129 130 - Documentation/CodingStyle 130 + Documentation/process/coding-style.rst 131 131 これは Linux カーネルのコーディングスタイルと背景にある理由を記述 132 132 しています。全ての新しいコードはこのドキュメントにあるガイドライン 133 133 に従っていることを期待されています。大部分のメンテナはこれらのルー 134 134 ルに従っているものだけを受け付け、多くの人は正しいスタイルのコード 135 135 だけをレビューします。 136 136 137 - Documentation/SubmittingPatches 138 - Documentation/SubmittingDrivers 137 + Documentation/process/submitting-patches.rst 138 + Documentation/process/submitting-drivers.rst 139 139 これらのファイルには、どうやってうまくパッチを作って投稿するかに 140 140 ついて非常に詳しく書かれており、以下を含みます(これだけに限らない 141 141 けれども) ··· 153 153 "Linux kernel patch submission format" 154 154 http://linux.yyz.us/patch-format.html 155 155 156 - Documentation/stable_api_nonsense.txt 156 + Documentation/process/stable-api-nonsense.rst 157 157 このファイルはカーネルの中に不変のAPIを持たないことにした意識的な 158 158 決断の背景にある理由について書かれています。以下のようなことを含 159 159 んでいます- ··· 164 164 このドキュメントは Linux 開発の思想を理解するのに非常に重要です。 165 165 そして、他のOSでの開発者が Linux に移る時にとても重要です。 166 166 167 - Documentation/SecurityBugs 167 + Documentation/admin-guide/security-bugs.rst 168 168 もし Linux カーネルでセキュリティ問題を発見したように思ったら、こ 169 169 のドキュメントのステップに従ってカーネル開発者に連絡し、問題解決を 170 170 支援してください。 171 171 172 - Documentation/ManagementStyle 172 + Documentation/process/management-style.rst 173 173 このドキュメントは Linux カーネルのメンテナ達がどう行動するか、 174 174 彼らの手法の背景にある共有されている精神について記述しています。こ 175 175 れはカーネル開発の初心者なら(もしくは、単に興味があるだけの人でも) 176 176 重要です。なぜならこのドキュメントは、カーネルメンテナ達の独特な 177 177 行動についての多くの誤解や混乱を解消するからです。 178 178 179 - Documentation/stable_kernel_rules.txt 179 + Documentation/process/stable-kernel-rules.rst 180 180 このファイルはどのように stable カーネルのリリースが行われるかのルー 181 181 ルが記述されています。そしてこれらのリリースの中のどこかで変更を取 182 182 り入れてもらいたい場合に何をすれば良いかが示されています。 183 183 184 - Documentation/kernel-docs.txt 184 + Documentation/process/kernel-docs.rst 185 185   カーネル開発に付随する外部ドキュメントのリストです。もしあなたが 186 186 探しているものがカーネル内のドキュメントでみつからなかった場合、 187 187 このリストをあたってみてください。 188 188 189 - Documentation/applying-patches.txt 189 + Documentation/process/applying-patches.rst 190 190 パッチとはなにか、パッチをどうやって様々なカーネルの開発ブランチに 191 191 適用するのかについて正確に記述した良い入門書です。 192 192 ··· 314 314 た問題がなければもう少し長くなることもあります。セキュリティ関連の問題 315 315 の場合はこれに対してだいたいの場合、すぐにリリースがされます。 316 316 317 - カーネルツリーに入っている、Documentation/stable_kernel_rules.txt ファ 317 + カーネルツリーに入っている、Documentation/process/stable-kernel-rules.rst ファ 318 318 イルにはどのような種類の変更が -stable ツリーに受け入れ可能か、またリ 319 319 リースプロセスがどう動くかが記述されています。 320 320 ··· 372 372 場所です。ユーザは見つけたバグの全てをこのツールで報告すべきです。 373 373 どう kernel bugzilla を使うかの詳細は、以下を参照してください- 374 374 http://bugzilla.kernel.org/page.cgi?id=faq.html 375 - メインカーネルソースディレクトリにあるファイル REPORTING-BUGS はカーネ 375 + メインカーネルソースディレクトリにあるファイル admin-guide/reporting-bugs.rst はカーネ 376 376 ルバグらしいものについてどうレポートするかの良いテンプレートであり、問 377 377 題の追跡を助けるためにカーネル開発者にとってどんな情報が必要なのかの詳 378 378 細が書かれています。 ··· 438 438 メールの先頭でなく、各引用行の間にあなたの言いたいことを追加するべきで 439 439 す。 440 440 441 - もしパッチをメールに付ける場合は、Documentation/SubmittingPatches に提 441 + もしパッチをメールに付ける場合は、Documentation/process/submitting-patches.rst に提 442 442 示されているように、それは プレーンな可読テキストにすることを忘れない 443 443 ようにしましょう。カーネル開発者は 添付や圧縮したパッチを扱いたがりま 444 444 せん-
+4 -4
Documentation/ja_JP/SubmitChecklist
··· 1 1 NOTE: 2 - This is a version of Documentation/SubmitChecklist into Japanese. 2 + This is a version of Documentation/process/submit-checklist.rst into Japanese. 3 3 This document is maintained by Takenori Nagano <t-nagano@ah.jp.nec.com> 4 4 and the JF Project team <http://www.linux.or.jp/JF/>. 5 5 If you find any difference between this document and the original file ··· 14 14 Last Updated: 2008/07/14 15 15 ================================== 16 16 これは、 17 - linux-2.6.26/Documentation/SubmitChecklist の和訳です。 17 + linux-2.6.26/Documentation/process/submit-checklist.rst の和訳です。 18 18 19 19 翻訳団体: JF プロジェクト < http://www.linux.or.jp/JF/ > 20 20 翻訳日: 2008/07/14 ··· 27 27 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 28 28 29 29 本書では、パッチをより素早く取り込んでもらいたい開発者が実践すべき基本的な事柄 30 - をいくつか紹介します。ここにある全ての事柄は、Documentation/SubmittingPatches 30 + をいくつか紹介します。ここにある全ての事柄は、Documentation/process/submitting-patches.rst 31 31 などのLinuxカーネルパッチ投稿に際しての心得を補足するものです。 32 32 33 33 1: 妥当なCONFIGオプションや変更されたCONFIGオプション、つまり =y, =m, =n ··· 84 84 必ずドキュメントを追加してください。 85 85 86 86 17: 新しいブートパラメータを追加した場合には、 87 - 必ずDocumentation/kernel-parameters.txt に説明を追加してください。 87 + 必ずDocumentation/admin-guide/kernel-parameters.rst に説明を追加してください。 88 88 89 89 18: 新しくmoduleにパラメータを追加した場合には、MODULE_PARM_DESC()を 90 90 利用して必ずその説明を記述してください。
+9 -9
Documentation/ja_JP/SubmittingPatches
··· 1 1 NOTE: 2 - This is a version of Documentation/SubmittingPatches into Japanese. 2 + This is a version of Documentation/process/submitting-patches.rst into Japanese. 3 3 This document is maintained by Keiichi KII <k-keiichi@bx.jp.nec.com> 4 4 and the JF Project team <http://www.linux.or.jp/JF/>. 5 5 If you find any difference between this document and the original file ··· 15 15 16 16 ================================== 17 17 これは、 18 - linux-2.6.39/Documentation/SubmittingPatches の和訳 18 + linux-2.6.39/Documentation/process/submitting-patches.rst の和訳 19 19 です。 20 20 翻訳団体: JF プロジェクト < http://www.linux.or.jp/JF/ > 21 21 翻訳日: 2011/06/09 ··· 34 34 おじけづかせることもあります。この文章はあなたの変更を大いに受け入れ 35 35 てもらえやすくする提案を集めたものです。 36 36 37 - コードを投稿する前に、Documentation/SubmitChecklist の項目リストに目 37 + コードを投稿する前に、Documentation/process/submit-checklist.rst の項目リストに目 38 38 を通してチェックしてください。もしあなたがドライバーを投稿しようとし 39 - ているなら、Documentation/SubmittingDrivers にも目を通してください。 39 + ているなら、Documentation/process/submitting-drivers.rst にも目を通してください。 40 40 41 41 -------------------------------------------- 42 42 セクション1 パッチの作り方と送り方 ··· 148 148 4) パッチのスタイルチェック 149 149 150 150 あなたのパッチが基本的な( Linux カーネルの)コーディングスタイルに違反し 151 - ていないかをチェックして下さい。その詳細を Documentation/CodingStyle で 151 + ていないかをチェックして下さい。その詳細を Documentation/process/coding-style.rst で 152 152 見つけることができます。コーディングスタイルの違反はレビューする人の 153 153 時間を無駄にするだけなので、恐らくあなたのパッチは読まれることすらなく 154 154 拒否されるでしょう。 ··· 246 246 あれば、誰かが MIME 形式のパッチを再送するよう求めるかもしれません。 247 247 248 248 余計な変更を加えずにあなたのパッチを送信するための電子メールクライアントの設定 249 - のヒントについては Documentation/email-clients.txt を参照してください。 249 + のヒントについては Documentation/process/email-clients.rst を参照してください。 250 250 251 251 8) 電子メールのサイズ 252 252 ··· 609 609 し例外を適用するには、本当に妥当な理由が不可欠です。あなたは恐らくこの 610 610 セクションを Linus のコンピュータ・サイエンス101と呼ぶでしょう。 611 611 612 - 1) Documentation/CodingStyleを参照 612 + 1) Documentation/process/coding-style.rstを参照 613 613 614 614 言うまでもなく、あなたのコードがこのコーディングスタイルからあまりに 615 615 も逸脱していると、レビューやコメントなしに受け取ってもらえないかもし ··· 704 704 NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people! 705 705 <https://lkml.org/lkml/2005/7/11/336> 706 706 707 - Kernel Documentation/CodingStyle: 708 - <http://users.sosdg.org/~qiyong/lxr/source/Documentation/CodingStyle> 707 + Kernel Documentation/process/coding-style.rst: 708 + <http://users.sosdg.org/~qiyong/lxr/source/Documentation/process/coding-style.rst> 709 709 710 710 Linus Torvalds's mail on the canonical patch format: 711 711 <http://lkml.org/lkml/2005/4/7/183>
+2 -2
Documentation/ja_JP/stable_api_nonsense.txt
··· 1 1 NOTE: 2 - This is a version of Documentation/stable_api_nonsense.txt into Japanese. 2 + This is a version of Documentation/process/stable-api-nonsense.rst into Japanese. 3 3 This document is maintained by IKEDA, Munehiro <m-ikeda@ds.jp.nec.com> 4 4 and the JF Project team <http://www.linux.or.jp/JF/>. 5 5 If you find any difference between this document and the original file ··· 14 14 Last Updated: 2007/07/18 15 15 ================================== 16 16 これは、 17 - linux-2.6.22-rc4/Documentation/stable_api_nonsense.txt の和訳 17 + linux-2.6.22-rc4/Documentation/process/stable-api-nonsense.rst の和訳 18 18 です。 19 19 翻訳団体: JF プロジェクト < http://www.linux.or.jp/JF/ > 20 20 翻訳日 : 2007/06/11
+3 -3
Documentation/ja_JP/stable_kernel_rules.txt
··· 1 1 NOTE: 2 - This is Japanese translated version of "Documentation/stable_kernel_rules.txt". 2 + This is Japanese translated version of "Documentation/process/stable-kernel-rules.rst". 3 3 This one is maintained by Tsugikazu Shibata <tshibata@ab.jp.nec.com> 4 4 and JF Project team <www.linux.or.jp/JF>. 5 5 If you find difference with original file or problem in translation, ··· 12 12 13 13 ================================== 14 14 これは、 15 - linux-2.6.29/Documentation/stable_kernel_rules.txt 15 + linux-2.6.29/Documentation/process/stable-kernel-rules.rst 16 16 の和訳です。 17 17 18 18 翻訳団体: JF プロジェクト < http://www.linux.or.jp/JF/ > ··· 43 43 "理論的には競合状態になる"ようなものは不可。 44 44 - いかなる些細な修正も含めることはできない。(スペルの修正、空白のクリー 45 45 ンアップなど) 46 - - Documentation/SubmittingPatches の規則に従ったものでなければならない。 46 + - Documentation/process/submitting-patches.rst の規則に従ったものでなければならない。 47 47 - パッチ自体か同等の修正が Linus のツリーに既に存在しなければならない。 48 48   Linus のツリーでのコミットID を -stable へのパッチ投稿の際に引用す 49 49 ること。
+1 -1
Documentation/kernel-per-CPU-kthreads.txt
··· 264 264 kthreads from being created in the first place. 265 265 2. Boot with "nosoftlockup=0", which will also prevent these kthreads 266 266 from being created. Other related watchdog and softlockup boot 267 - parameters may be found in Documentation/kernel-parameters.txt 267 + parameters may be found in Documentation/admin-guide/kernel-parameters.rst 268 268 and Documentation/watchdog/watchdog-parameters.txt. 269 269 3. Echo a zero to /proc/sys/kernel/watchdog to disable the 270 270 watchdog timer.
+15 -15
Documentation/ko_KR/HOWTO
··· 1 1 NOTE: 2 - This is a version of Documentation/HOWTO translated into korean 2 + This is a version of Documentation/process/howto.rst translated into korean 3 3 This document is maintained by Minchan Kim <minchan@kernel.org> 4 4 If you find any difference between this document and the original file or 5 5 a problem with the translation, please contact the maintainer of this file. ··· 11 11 12 12 ================================== 13 13 이 문서는 14 - Documentation/HOWTO 14 + Documentation/process/howto.rst 15 15 의 한글 번역입니다. 16 16 17 17 역자: 김민찬 <minchan@kernel.org> ··· 98 98 빌드하기 위해 필요한 것을 설명한다. 커널에 입문하는 사람들은 여기서 99 99 시작해야 한다. 100 100 101 - Documentation/Changes 101 + Documentation/process/changes.rst 102 102 이 파일은 커널을 성공적으로 빌드하고 실행시키기 위해 필요한 다양한 103 103 소프트웨어 패키지들의 최소 버젼을 나열한다. 104 104 105 - Documentation/CodingStyle 105 + Documentation/process/coding-style.rst 106 106 이 문서는 리눅스 커널 코딩 스타일과 그렇게 한 몇몇 이유를 설명한다. 107 107 모든 새로운 코드는 이 문서에 가이드라인들을 따라야 한다. 대부분의 108 108 메인테이너들은 이 규칙을 따르는 패치들만을 받아들일 것이고 많은 사람들이 109 109 그 패치가 올바른 스타일일 경우만 코드를 검토할 것이다. 110 110 111 - Documentation/SubmittingPatches 112 - Documentation/SubmittingDrivers 111 + Documentation/process/submitting-patches.rst 112 + Documentation/process/submitting-drivers.rst 113 113 이 파일들은 성공적으로 패치를 만들고 보내는 법을 다음의 내용들로 114 114 굉장히 상세히 설명하고 있다(그러나 다음으로 한정되진 않는다). 115 115 - Email 내용들 ··· 126 126 "Linux kernel patch submission format" 127 127 http://linux.yyz.us/patch-format.html 128 128 129 - Documentation/stable_api_nonsense.txt 129 + Documentation/process/stable-api-nonsense.rst 130 130 이 문서는 의도적으로 커널이 불변하는 API를 갖지 않도록 결정한 131 131 이유를 설명하며 다음과 같은 것들을 포함한다. 132 132 - 서브시스템 shim-layer(호환성을 위해?) ··· 136 136 리눅스로 전향하는 사람들에게는 매우 중요하다. 137 137 138 138 139 - Documentation/SecurityBugs 139 + Documentation/admin-guide/security-bugs.rst 140 140 여러분들이 리눅스 커널의 보안 문제를 발견했다고 생각한다면 이 문서에 141 141 나온 단계에 따라서 커널 개발자들에게 알리고 그 문제를 해결할 수 있도록 142 142 도와 달라. 143 143 144 - Documentation/ManagementStyle 144 + Documentation/process/management-style.rst 145 145 이 문서는 리눅스 커널 메인테이너들이 그들의 방법론에 녹아 있는 146 146 정신을 어떻게 공유하고 운영하는지를 설명한다. 이것은 커널 개발에 입문하는 147 147 모든 사람들(또는 커널 개발에 작은 호기심이라도 있는 사람들)이 ··· 149 149 독특한 행동에 관하여 흔히 있는 오해들과 혼란들을 해소하고 있기 150 150 때문이다. 151 151 152 - Documentation/stable_kernel_rules.txt 152 + Documentation/process/stable-kernel-rules.rst 153 153 이 문서는 안정적인 커널 배포가 이루어지는 규칙을 설명하고 있으며 154 154 여러분들이 이러한 배포들 중 하나에 변경을 하길 원한다면 155 155 무엇을 해야 하는지를 설명한다. 156 156 157 - Documentation/kernel-docs.txt 157 + Documentation/process/kernel-docs.rst 158 158 커널 개발에 관계된 외부 문서의 리스트이다. 커널 내의 포함된 문서들 159 159 중에 여러분이 찾고 싶은 문서를 발견하지 못할 경우 이 리스트를 160 160 살펴보라. 161 161 162 - Documentation/applying-patches.txt 162 + Documentation/process/applying-patches.rst 163 163 패치가 무엇이며 그것을 커널의 다른 개발 브랜치들에 어떻게 164 164 적용하는지에 관하여 자세히 설명하고 있는 좋은 입문서이다. 165 165 ··· 276 276 4.x.y는 "stable" 팀<stable@vger.kernel.org>에 의해 관리되며 거의 매번 격주로 277 277 배포된다. 278 278 279 - 커널 트리 문서들 내에 Documentation/stable_kernel_rules.txt 파일은 어떤 279 + 커널 트리 문서들 내에 Documentation/process/stable-kernel-rules.rst 파일은 어떤 280 280 종류의 변경들이 -stable 트리로 들어왔는지와 배포 프로세스가 어떻게 281 281 진행되는지를 설명한다. 282 282 ··· 328 328 kernel bugzilla를 사용하는 자세한 방법은 다음을 참조하라. 329 329 http://test.kernel.org/bugzilla/faq.html 330 330 331 - 메인 커널 소스 디렉토리에 있는 REPORTING-BUGS 파일은 커널 버그라고 생각되는 331 + 메인 커널 소스 디렉토리에 있는 admin-guide/reporting-bugs.rst 파일은 커널 버그라고 생각되는 332 332 것을 보고하는 방법에 관한 좋은 템플릿이며 문제를 추적하기 위해서 커널 333 333 개발자들이 필요로 하는 정보가 무엇들인지를 상세히 설명하고 있다. 334 334 ··· 391 391 "John 커널해커는 작성했다...."를 유지하며 여러분들의 의견을 그 메일의 윗부분에 392 392 작성하지 말고 각 인용한 단락들 사이에 넣어라. 393 393 394 - 여러분들이 패치들을 메일에 넣는다면 그것들은 Documentation/SubmittingPatches에 394 + 여러분들이 패치들을 메일에 넣는다면 그것들은 Documentation/process/submitting-patches.rst에 395 395 나와있는데로 명백히(plain) 읽을 수 있는 텍스트여야 한다. 커널 개발자들은 396 396 첨부파일이나 압축된 패치들을 원하지 않는다. 그들은 여러분들의 패치의 397 397 각 라인 단위로 코멘트를 하길 원하며 압축하거나 첨부하지 않고 보내는 것이
+2 -2
Documentation/ko_KR/stable_api_nonsense.txt
··· 1 1 NOTE: 2 - This is a version of Documentation/stable_api_nonsense.txt translated 2 + This is a version of Documentation/process/stable-api-nonsense.rst translated 3 3 into korean 4 4 This document is maintained by Minchan Kim <minchan@kernel.org> 5 5 If you find any difference between this document and the original file or ··· 12 12 13 13 ================================== 14 14 이 문서는 15 - Documentation/stable_api_nonsense.txt 15 + Documentation/process/stable-api-nonsense.rst 16 16 의 한글 번역입니다. 17 17 18 18 역자: 김민찬 <minchan@kernel.org>
+2 -2
Documentation/lockup-watchdogs.txt
··· 11 11 stack trace is displayed upon detection and, by default, the system 12 12 will stay locked up. Alternatively, the kernel can be configured to 13 13 panic; a sysctl, "kernel.softlockup_panic", a kernel parameter, 14 - "softlockup_panic" (see "Documentation/kernel-parameters.txt" for 14 + "softlockup_panic" (see "Documentation/admin-guide/kernel-parameters.rst" for 15 15 details), and a compile option, "BOOTPARAM_SOFTLOCKUP_PANIC", are 16 16 provided for this. 17 17 ··· 23 23 behavior is changed, which can be done through a sysctl, 24 24 'hardlockup_panic', a compile time knob, "BOOTPARAM_HARDLOCKUP_PANIC", 25 25 and a kernel parameter, "nmi_watchdog" 26 - (see "Documentation/kernel-parameters.txt" for details). 26 + (see "Documentation/admin-guide/kernel-parameters.rst" for details). 27 27 28 28 The panic option can be used in combination with panic_timeout (this 29 29 timeout is set through the confusingly named "kernel.panic" sysctl),
+1 -1
Documentation/m68k/kernel-options.txt
··· 139 139 PARTUUID=00112233-4455-6677-8899-AABBCCDDEEFF/PARTNROFF=-2 140 140 141 141 Authoritative information can be found in 142 - "Documentation/kernel-parameters.txt". 142 + "Documentation/admin-guide/kernel-parameters.rst". 143 143 144 144 145 145 2.2) ro, rw
+2 -2
Documentation/media/uapi/v4l/diff-v4l.rst
··· 648 648 devices is documented in :ref:`extended-controls`. 649 649 650 650 .. [#f1] 651 - According to Documentation/devices.txt these should be symbolic links 651 + According to Documentation/admin-guide/devices.rst these should be symbolic links 652 652 to ``/dev/video0``. Note the original bttv interface is not 653 653 compatible with V4L or V4L2. 654 654 655 655 .. [#f2] 656 - According to ``Documentation/devices.txt`` a symbolic link to 656 + According to ``Documentation/admin-guide/devices.rst`` a symbolic link to 657 657 ``/dev/radio0``. 658 658 659 659 .. [#f3]
+2 -2
Documentation/media/v4l-drivers/bttv.rst
··· 304 304 With a hard freeze you probably doesn't find anything in the logfiles. 305 305 The only way to capture any kernel messages is to hook up a serial 306 306 console and let some terminal application log the messages. /me uses 307 - screen. See Documentation/serial-console.txt for details on setting 307 + screen. See Documentation/admin-guide/serial-console.rst for details on setting 308 308 up a serial console. 309 309 310 - Read Documentation/oops-tracing.txt to learn how to get any useful 310 + Read Documentation/admin-guide/oops-tracing.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
+1 -1
Documentation/memory-hotplug.txt
··· 324 324 Now, a boot option for making a memory block which consists of migratable pages 325 325 is supported. By specifying "kernelcore=" or "movablecore=" boot option, you can 326 326 create ZONE_MOVABLE...a zone which is just used for movable pages. 327 - (See also Documentation/kernel-parameters.txt) 327 + (See also Documentation/admin-guide/kernel-parameters.rst) 328 328 329 329 Assume the system has "TOTAL" amount of memory at boot time, this boot option 330 330 creates ZONE_MOVABLE as following.
+1 -1
Documentation/networking/netconsole.txt
··· 200 200 or by specifying "debug" on the kernel command line at boot, to send 201 201 all kernel messages to the console. A specific value for this parameter 202 202 can also be set using the "loglevel" kernel boot option. See the 203 - dmesg(8) man page and Documentation/kernel-parameters.txt for details. 203 + dmesg(8) man page and Documentation/admin-guide/kernel-parameters.rst for details. 204 204 205 205 Netconsole was designed to be as instantaneous as possible, to 206 206 enable the logging of even the most critical kernel bugs. It works
+4 -4
Documentation/networking/netdev-FAQ.txt
··· 136 136 137 137 Q: I see a network patch and I think it should be backported to stable. 138 138 Should I request it via "stable@vger.kernel.org" like the references in 139 - the kernel's Documentation/stable_kernel_rules.txt file say? 139 + the kernel's Documentation/process/stable-kernel-rules.rst file say? 140 140 141 141 A: No, not for networking. Check the stable queues as per above 1st to see 142 142 if it is already queued. If not, then send a mail to netdev, listing 143 143 the upstream commit ID and why you think it should be a stable candidate. 144 144 145 145 Before you jump to go do the above, do note that the normal stable rules 146 - in Documentation/stable_kernel_rules.txt still apply. So you need to 146 + in Documentation/process/stable-kernel-rules.rst still apply. So you need to 147 147 explicitly indicate why it is a critical fix and exactly what users are 148 148 impacted. In addition, you need to convince yourself that you _really_ 149 149 think it has been overlooked, vs. having been considered and rejected. ··· 165 165 166 166 If you think there is some valid information relating to it being in 167 167 stable that does _not_ belong in the commit log, then use the three 168 - dash marker line as described in Documentation/SubmittingPatches to 168 + dash marker line as described in Documentation/process/submitting-patches.rst to 169 169 temporarily embed that information into the patch that you send. 170 170 171 171 Q: Someone said that the comment style and coding convention is different ··· 220 220 If it is your first patch, mail it to yourself so you can test apply 221 221 it to an unpatched tree to confirm infrastructure didn't mangle it. 222 222 223 - Finally, go back and read Documentation/SubmittingPatches to be 223 + Finally, go back and read Documentation/process/submitting-patches.rst to be 224 224 sure you are not repeating some common mistake documented there.
+1 -1
Documentation/networking/vortex.txt
··· 364 364 365 365 - The contents of your report will vary a lot depending upon the 366 366 problem. If it's a kernel crash then you should refer to the 367 - REPORTING-BUGS file. 367 + admin-guide/reporting-bugs.rst file. 368 368 369 369 But for most problems it is useful to provide the following: 370 370
+1 -1
Documentation/power/00-INDEX
··· 6 6 - Debugging suspend and resume 7 7 charger-manager.txt 8 8 - Battery charger management. 9 - devices.txt 9 + admin-guide/devices.rst 10 10 - How drivers interact with system-wide power management 11 11 drivers-testing.txt 12 12 - Testing suspend and resume support in device drivers
+5 -5
Documentation/power/pci.txt
··· 8 8 9 9 This document only covers the aspects of power management specific to PCI 10 10 devices. For general description of the kernel's interfaces related to device 11 - power management refer to Documentation/power/devices.txt and 11 + power management refer to Documentation/power/admin-guide/devices.rst and 12 12 Documentation/power/runtime_pm.txt. 13 13 14 14 --------------------------------------------------------------------------- ··· 417 417 2.4. System-Wide Power Transitions 418 418 ---------------------------------- 419 419 There are a few different types of system-wide power transitions, described in 420 - Documentation/power/devices.txt. Each of them requires devices to be handled 420 + Documentation/power/admin-guide/devices.rst. Each of them requires devices to be handled 421 421 in a specific way and the PM core executes subsystem-level power management 422 422 callbacks for this purpose. They are executed in phases such that each phase 423 423 involves executing the same subsystem-level callback for every device belonging ··· 623 623 pre-hibernation memory contents to be restored before the pre-hibernation system 624 624 activity can be resumed. 625 625 626 - As described in Documentation/power/devices.txt, the hibernation image is loaded 626 + As described in Documentation/power/admin-guide/devices.rst, the hibernation image is loaded 627 627 into memory by a fresh instance of the kernel, called the boot kernel, which in 628 628 turn is loaded and run by a boot loader in the usual way. After the boot kernel 629 629 has loaded the image, it needs to replace its own code and data with the code ··· 677 677 678 678 At the time of this writing there are two ways to define power management 679 679 callbacks for a PCI device driver, the recommended one, based on using a 680 - dev_pm_ops structure described in Documentation/power/devices.txt, and the 680 + dev_pm_ops structure described in Documentation/power/admin-guide/devices.rst, and the 681 681 "legacy" one, in which the .suspend(), .suspend_late(), .resume_early(), and 682 682 .resume() callbacks from struct pci_driver are used. The legacy approach, 683 683 however, doesn't allow one to define runtime power management callbacks and is ··· 1046 1046 PCI Bus Power Management Interface Specification, Rev. 1.2 1047 1047 Advanced Configuration and Power Interface (ACPI) Specification, Rev. 3.0b 1048 1048 PCI Express Base Specification, Rev. 2.0 1049 - Documentation/power/devices.txt 1049 + Documentation/power/admin-guide/devices.rst 1050 1050 Documentation/power/runtime_pm.txt
+1 -1
Documentation/power/runtime_pm.txt
··· 674 674 system suspend and resume callbacks for all of those devices, except for the 675 675 complete callback, which is then entirely responsible for handling the device 676 676 as appropriate. This only applies to system suspend transitions that are not 677 - related to hibernation (see Documentation/power/devices.txt for more 677 + related to hibernation (see Documentation/power/admin-guide/devices.rst for more 678 678 information). 679 679 680 680 The PM core does its best to reduce the probability of race conditions between
+1 -1
Documentation/power/swsusp-dmcrypt.txt
··· 8 8 You know how dm-crypt works. If not, visit the following web page: 9 9 http://www.saout.de/misc/dm-crypt/ 10 10 You have read Documentation/power/swsusp.txt and understand it. 11 - You did read Documentation/initrd.txt and know how an initrd works. 11 + You did read Documentation/admin-guide/initrd.rst and know how an initrd works. 12 12 You know how to create or how to modify an initrd. 13 13 14 14 Now your system is properly set up, your disk is encrypted except for
+2 -2
Documentation/process/4.Coding.rst
··· 22 22 ************ 23 23 24 24 The kernel has long had a standard coding style, described in 25 - Documentation/CodingStyle. For much of that time, the policies described 25 + Documentation/process/coding-style.rst. For much of that time, the policies described 26 26 in that file were taken as being, at most, advisory. As a result, there is 27 27 a substantial amount of code in the kernel which does not meet the coding 28 28 style guidelines. The presence of that code leads to two independent ··· 343 343 Documentation/ABI/README for a description of how this documentation should 344 344 be formatted and what information needs to be provided. 345 345 346 - The file Documentation/kernel-parameters.txt describes all of the kernel's 346 + The file Documentation/admin-guide/kernel-parameters.rst describes all of the kernel's 347 347 boot-time parameters. Any patch which adds new parameters should add the 348 348 appropriate entries to this file. 349 349
+6 -6
Documentation/process/5.Posting.rst
··· 9 9 of conventions and procedures which are used in the posting of patches; 10 10 following them will make life much easier for everybody involved. This 11 11 document will attempt to cover these expectations in reasonable detail; 12 - more information can also be found in the files SubmittingPatches, 13 - SubmittingDrivers, and SubmitChecklist in the kernel documentation 12 + more information can also be found in the files process/submitting-patches.rst, 13 + process/submitting-drivers.rst, and process/submit-checklist.rst in the kernel documentation 14 14 directory. 15 15 16 16 ··· 198 198 199 199 The tags mentioned above are used to describe how various developers have 200 200 been associated with the development of this patch. They are described in 201 - detail in the SubmittingPatches document; what follows here is a brief 201 + detail in the process/submitting-patches.rst document; what follows here is a brief 202 202 summary. Each of these lines has the format: 203 203 204 204 :: ··· 210 210 - Signed-off-by: this is a developer's certification that he or she has 211 211 the right to submit the patch for inclusion into the kernel. It is an 212 212 agreement to the Developer's Certificate of Origin, the full text of 213 - which can be found in Documentation/SubmittingPatches. Code without a 213 + which can be found in Documentation/process/submitting-patches.rst. Code without a 214 214 proper signoff cannot be merged into the mainline. 215 215 216 216 - Acked-by: indicates an agreement by another developer (often a ··· 221 221 it to work. 222 222 223 223 - Reviewed-by: the named developer has reviewed the patch for correctness; 224 - see the reviewer's statement in Documentation/SubmittingPatches for more 224 + see the reviewer's statement in Documentation/process/submitting-patches.rst for more 225 225 detail. 226 226 227 227 - Reported-by: names a user who reported a problem which is fixed by this ··· 248 248 be examined in any detail. If there is any doubt at all, mail the patch 249 249 to yourself and convince yourself that it shows up intact. 250 250 251 - Documentation/email-clients.txt has some helpful hints on making 251 + Documentation/process/email-clients.rst has some helpful hints on making 252 252 specific mail clients work for sending patches. 253 253 254 254 - Are you sure your patch is free of silly mistakes? You should always
+3 -3
Documentation/process/8.Conclusion.rst
··· 5 5 6 6 There are numerous sources of information on Linux kernel development and 7 7 related topics. First among those will always be the Documentation 8 - directory found in the kernel source distribution. The top-level HOWTO 9 - file is an important starting point; SubmittingPatches and 10 - SubmittingDrivers are also something which all kernel developers should 8 + directory found in the kernel source distribution. The top-level process/howto.rst 9 + file is an important starting point; process/submitting-patches.rst and 10 + process/submitting-drivers.rst are also something which all kernel developers should 11 11 read. Many internal kernel APIs are documented using the kerneldoc 12 12 mechanism; "make htmldocs" or "make pdfdocs" can be used to generate those 13 13 documents in HTML or PDF format (though the version of TeX shipped by some
+1 -1
Documentation/process/adding-syscalls.rst
··· 3 3 4 4 This document describes what's involved in adding a new system call to the 5 5 Linux kernel, over and above the normal submission advice in 6 - :ref:`Documentation/SubmittingPatches <submittingpatches>`. 6 + :ref:`Documentation/process/submitting-patches.rst <submittingpatches>`. 7 7 8 8 9 9 System Call Alternatives
+1 -1
Documentation/process/coding-style.rst
··· 1058 1058 WG14 is the international standardization working group for the programming 1059 1059 language C, URL: http://www.open-std.org/JTC1/SC22/WG14/ 1060 1060 1061 - Kernel CodingStyle, by greg@kroah.com at OLS 2002: 1061 + Kernel process/coding-style.rst, by greg@kroah.com at OLS 2002: 1062 1062 http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/
+12 -12
Documentation/process/howto.rst
··· 90 90 what is necessary to do to configure and build the kernel. People 91 91 who are new to the kernel should start here. 92 92 93 - :ref:`Documentation/Changes <changes>` 93 + :ref:`Documentation/process/changes.rst <changes>` 94 94 This file gives a list of the minimum levels of various software 95 95 packages that are necessary to build and run the kernel 96 96 successfully. 97 97 98 - :ref:`Documentation/CodingStyle <codingstyle>` 98 + :ref:`Documentation/process/coding-style.rst <codingstyle>` 99 99 This describes the Linux kernel coding style, and some of the 100 100 rationale behind it. All new code is expected to follow the 101 101 guidelines in this document. Most maintainers will only accept 102 102 patches if these rules are followed, and many people will only 103 103 review code if it is in the proper style. 104 104 105 - :ref:`Documentation/SubmittingPatches <submittingpatches>` and :ref:`Documentation/SubmittingDrivers <submittingdrivers>` 105 + :ref:`Documentation/process/submitting-patches.rst <submittingpatches>` and :ref:`Documentation/process/submitting-drivers.rst <submittingdrivers>` 106 106 These files describe in explicit detail how to successfully create 107 107 and send a patch, including (but not limited to): 108 108 ··· 122 122 "Linux kernel patch submission format" 123 123 http://linux.yyz.us/patch-format.html 124 124 125 - :ref:`Documentation/stable_api_nonsense.txt <stable_api_nonsense>` 125 + :ref:`Documentation/process/stable-api-nonsense.rst <stable_api_nonsense>` 126 126 This file describes the rationale behind the conscious decision to 127 127 not have a stable API within the kernel, including things like: 128 128 ··· 135 135 philosophy and is very important for people moving to Linux from 136 136 development on other Operating Systems. 137 137 138 - :ref:`Documentation/SecurityBugs <securitybugs>` 138 + :ref:`Documentation/admin-guide/security-bugs.rst <securitybugs>` 139 139 If you feel you have found a security problem in the Linux kernel, 140 140 please follow the steps in this document to help notify the kernel 141 141 developers, and help solve the issue. 142 142 143 - :ref:`Documentation/ManagementStyle <managementstyle>` 143 + :ref:`Documentation/process/management-style.rst <managementstyle>` 144 144 This document describes how Linux kernel maintainers operate and the 145 145 shared ethos behind their methodologies. This is important reading 146 146 for anyone new to kernel development (or anyone simply curious about 147 147 it), as it resolves a lot of common misconceptions and confusion 148 148 about the unique behavior of kernel maintainers. 149 149 150 - :ref:`Documentation/stable_kernel_rules.txt <stable_kernel_rules>` 150 + :ref:`Documentation/process/stable-kernel-rules.rst <stable_kernel_rules>` 151 151 This file describes the rules on how the stable kernel releases 152 152 happen, and what to do if you want to get a change into one of these 153 153 releases. 154 154 155 - :ref:`Documentation/kernel-docs.txt <kernel_docs>` 155 + :ref:`Documentation/process/kernel-docs.rst <kernel_docs>` 156 156 A list of external documentation that pertains to kernel 157 157 development. Please consult this list if you do not find what you 158 158 are looking for within the in-kernel documentation. 159 159 160 - :ref:`Documentation/applying-patches.txt <applying_patches>` 160 + :ref:`Documentation/process/applying-patches.rst <applying_patches>` 161 161 A good introduction describing exactly what a patch is and how to 162 162 apply it to the different development branches of the kernel. 163 163 ··· 307 307 security-related problem, instead, can cause a release to happen almost 308 308 instantly. 309 309 310 - The file Documentation/stable_kernel_rules.txt in the kernel tree 310 + The file Documentation/process/stable-kernel-rules.rst in the kernel tree 311 311 documents what kinds of changes are acceptable for the -stable tree, and 312 312 how the release process works. 313 313 ··· 366 366 367 367 https://bugzilla.kernel.org/page.cgi?id=faq.html 368 368 369 - The file REPORTING-BUGS in the main kernel source directory has a good 369 + The file admin-guide/reporting-bugs.rst in the main kernel source directory has a good 370 370 template for how to report a possible kernel bug, and details what kind 371 371 of information is needed by the kernel developers to help track down the 372 372 problem. ··· 440 440 writing at the top of the mail. 441 441 442 442 If you add patches to your mail, make sure they are plain readable text 443 - as stated in Documentation/SubmittingPatches. 443 + as stated in Documentation/process/submitting-patches.rst. 444 444 Kernel developers don't want to deal with 445 445 attachments or compressed patches; they may want to comment on 446 446 individual lines of your patch, which works only that way. Make sure you
+1 -1
Documentation/process/management-style.rst
··· 5 5 6 6 This is a short document describing the preferred (or made up, depending 7 7 on who you ask) management style for the linux kernel. It's meant to 8 - mirror the CodingStyle document to some degree, and mainly written to 8 + mirror the process/coding-style.rst document to some degree, and mainly written to 9 9 avoid answering [#f1]_ the same (or similar) questions over and over again. 10 10 11 11 Management style is very personal and much harder to quantify than
+2 -2
Documentation/process/stable-kernel-rules.rst
··· 27 27 - It cannot contain any "trivial" fixes in it (spelling changes, 28 28 whitespace cleanups, etc). 29 29 - It must follow the 30 - :ref:`Documentation/SubmittingPatches <submittingpatches>` 30 + :ref:`Documentation/process/submitting-patches.rst <submittingpatches>` 31 31 rules. 32 32 - It or an equivalent fix must already exist in Linus' tree (upstream). 33 33 ··· 40 40 Documentation/networking/netdev-FAQ.txt 41 41 - Security patches should not be handled (solely) by the -stable review 42 42 process but should follow the procedures in 43 - :ref:`Documentation/SecurityBugs <securitybugs>`. 43 + :ref:`Documentation/admin-guide/security-bugs.rst <securitybugs>`. 44 44 45 45 For all other submissions, choose one of the following procedures 46 46 -----------------------------------------------------------------
+3 -3
Documentation/process/submit-checklist.rst
··· 7 7 kernel patch submissions accepted more quickly. 8 8 9 9 These are all above and beyond the documentation that is provided in 10 - :ref:`Documentation/SubmittingPatches <submittingpatches>` 10 + :ref:`Documentation/process/submitting-patches.rst <submittingpatches>` 11 11 and elsewhere regarding submitting Linux kernel patches. 12 12 13 13 ··· 31 31 tends to use ``unsigned long`` for 64-bit quantities. 32 32 33 33 5) Check your patch for general style as detailed in 34 - :ref:`Documentation/CodingStyle <codingstyle>`. 34 + :ref:`Documentation/process/coding-style.rst <codingstyle>`. 35 35 Check for trivial violations with the patch style checker prior to 36 36 submission (``scripts/checkpatch.pl``). 37 37 You should be able to justify all violations that remain in ··· 78 78 16) All new ``/proc`` entries are documented under ``Documentation/`` 79 79 80 80 17) All new kernel boot parameters are documented in 81 - ``Documentation/kernel-parameters.txt``. 81 + ``Documentation/admin-guide/kernel-parameters.rst``. 82 82 83 83 18) All new module parameters are documented with ``MODULE_PARM_DESC()`` 84 84
+4 -4
Documentation/process/submitting-drivers.rst
··· 8 8 you should probably talk to XFree86 (http://www.xfree86.org/) and/or X.Org 9 9 (http://x.org/) instead. 10 10 11 - Also read the Documentation/SubmittingPatches document. 11 + Also read the Documentation/process/submitting-patches.rst document. 12 12 13 13 14 14 Allocating Device Numbers ··· 19 19 Torben Mathiasen). The site is http://www.lanana.org/. This 20 20 also deals with allocating numbers for devices that are not going to 21 21 be submitted to the mainstream kernel. 22 - See Documentation/devices.txt for more information on this. 22 + See Documentation/admin-guide/devices.rst for more information on this. 23 23 24 24 If you don't use assigned numbers then when your device is submitted it will 25 25 be given an assigned number even if that is different from values you may ··· 73 73 74 74 Code: 75 75 Please use the Linux style of code formatting as documented 76 - in :ref:`Documentation/CodingStyle <codingStyle>`. 76 + in :ref:`Documentation/process/coding-style.rst <codingStyle>`. 77 77 If you have sections of code 78 78 that need to be in other formats, for example because they 79 79 are shared with a windows driver kit and you want to ··· 109 109 anything. For the driver testing instructions see 110 110 Documentation/power/drivers-testing.txt and for a relatively 111 111 complete overview of the power management issues related to 112 - drivers see Documentation/power/devices.txt . 112 + drivers see Documentation/power/admin-guide/devices.rst . 113 113 114 114 Control: 115 115 In general if there is active maintenance of a driver by
+7 -7
Documentation/process/submitting-patches.rst
··· 11 11 This document contains a large number of suggestions in a relatively terse 12 12 format. For detailed information on how the kernel development process 13 13 works, see :ref:`Documentation/process <development_process_main>`. 14 - Also, read :ref:`Documentation/SubmitChecklist <submitchecklist>` 14 + Also, read :ref:`Documentation/process/submit-checklist.rst <submitchecklist>` 15 15 for a list of items to check before 16 16 submitting code. If you are submitting a driver, also read 17 - :ref:`Documentation/SubmittingDrivers <submittingdrivers>`; 17 + :ref:`Documentation/process/submitting-drivers.rst <submittingdrivers>`; 18 18 for device tree binding patches, read 19 19 Documentation/devicetree/bindings/submitting-patches.txt. 20 20 ··· 238 238 239 239 Check your patch for basic style violations, details of which can be 240 240 found in 241 - :ref:`Documentation/CodingStyle <codingstyle>`. 241 + :ref:`Documentation/process/coding-style.rst <codingstyle>`. 242 242 Failure to do so simply wastes 243 243 the reviewers time and will get your patch rejected, probably 244 244 without even being read. ··· 305 305 306 306 into the sign-off area of your patch (note, NOT an email recipient). You 307 307 should also read 308 - :ref:`Documentation/stable_kernel_rules.txt <stable_kernel_rules>` 308 + :ref:`Documentation/process/stable-kernel-rules.rst <stable_kernel_rules>` 309 309 in addition to this file. 310 310 311 311 Note, however, that some subsystem maintainers want to come to their own ··· 363 363 Exception: If your mailer is mangling patches then someone may ask 364 364 you to re-send them using MIME. 365 365 366 - See :ref:`Documentation/email-clients.txt <email_clients>` 366 + See :ref:`Documentation/process/email-clients.rst <email_clients>` 367 367 for hints about configuring your e-mail client so that it sends your patches 368 368 untouched. 369 369 ··· 828 828 NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people! 829 829 <https://lkml.org/lkml/2005/7/11/336> 830 830 831 - Kernel Documentation/CodingStyle: 832 - :ref:`Documentation/CodingStyle <codingstyle>` 831 + Kernel Documentation/process/coding-style.rst: 832 + :ref:`Documentation/process/coding-style.rst <codingstyle>` 833 833 834 834 Linus Torvalds's mail on the canonical patch format: 835 835 <http://lkml.org/lkml/2005/4/7/183>
+1 -1
Documentation/rfkill.txt
··· 26 26 the system software. 27 27 28 28 The rfkill subsystem has two parameters, rfkill.default_state and 29 - rfkill.master_switch_mode, which are documented in kernel-parameters.txt. 29 + rfkill.master_switch_mode, which are documented in admin-guide/kernel-parameters.rst. 30 30 31 31 32 32 2. Implementation details
+1 -1
Documentation/scsi/scsi-parameters.txt
··· 1 1 SCSI Kernel Parameters 2 2 ~~~~~~~~~~~~~~~~~~~~~~ 3 3 4 - See Documentation/kernel-parameters.txt for general information on 4 + See Documentation/admin-guide/kernel-parameters.rst for general information on 5 5 specifying module parameters. 6 6 7 7 This document may not be entirely up to date and comprehensive. The command
+1 -1
Documentation/scsi/scsi_mid_low_api.txt
··· 336 336 Conventions 337 337 =========== 338 338 First, Linus Torvalds's thoughts on C coding style can be found in the 339 - Documentation/CodingStyle file. 339 + Documentation/process/coding-style.rst file. 340 340 341 341 Next, there is a movement to "outlaw" typedefs introducing synonyms for 342 342 struct tags. Both can be still found in the SCSI subsystem, but
+1 -1
Documentation/scsi/sym53c8xx_2.txt
··· 427 427 10.1 Syntax 428 428 429 429 Setup commands can be passed to the driver either at boot time or as 430 - parameters to modprobe, as described in Documentation/kernel-parameters.txt 430 + parameters to modprobe, as described in Documentation/admin-guide/kernel-parameters.rst 431 431 432 432 Example of boot setup command under lilo prompt: 433 433
+1 -1
Documentation/sound/alsa/alsa-parameters.txt
··· 1 1 ALSA Kernel Parameters 2 2 ~~~~~~~~~~~~~~~~~~~~~~ 3 3 4 - See Documentation/kernel-parameters.txt for general information on 4 + See Documentation/admin-guide/kernel-parameters.rst for general information on 5 5 specifying module parameters. 6 6 7 7 This document may not be entirely up to date and comprehensive. The command
+1 -1
Documentation/sound/oss/oss-parameters.txt
··· 1 1 OSS Kernel Parameters 2 2 ~~~~~~~~~~~~~~~~~~~~~ 3 3 4 - See Documentation/kernel-parameters.txt for general information on 4 + See Documentation/admin-guide/kernel-parameters.rst for general information on 5 5 specifying module parameters. 6 6 7 7 This document may not be entirely up to date and comprehensive. The command
+2 -2
Documentation/sysctl/kernel.txt
··· 71 71 - printk_ratelimit_burst 72 72 - pty ==> Documentation/filesystems/devpts.txt 73 73 - randomize_va_space 74 - - real-root-dev ==> Documentation/initrd.txt 74 + - real-root-dev ==> Documentation/admin-guide/initrd.rst 75 75 - reboot-cmd [ SPARC only ] 76 76 - rtsig-max 77 77 - rtsig-nr ··· 453 453 454 454 nmi_watchdog=1 455 455 456 - to the guest kernel command line (see Documentation/kernel-parameters.txt). 456 + to the guest kernel command line (see Documentation/admin-guide/kernel-parameters.rst). 457 457 458 458 ============================================================== 459 459
+2 -2
Documentation/virtual/kvm/review-checklist.txt
··· 1 1 Review checklist for kvm patches 2 2 ================================ 3 3 4 - 1. The patch must follow Documentation/CodingStyle and 5 - Documentation/SubmittingPatches. 4 + 1. The patch must follow Documentation/process/coding-style.rst and 5 + Documentation/process/submitting-patches.rst. 6 6 7 7 2. Patches should be against kvm.git master branch. 8 8
+1 -1
Documentation/vm/numa
··· 82 82 a default zonelist order based on the sizes of the various zone types relative 83 83 to the total memory of the node and the total memory of the system. The 84 84 default zonelist order may be overridden using the numa_zonelist_order kernel 85 - boot parameter or sysctl. [see Documentation/kernel-parameters.txt and 85 + boot parameter or sysctl. [see Documentation/admin-guide/kernel-parameters.rst and 86 86 Documentation/sysctl/vm.txt] 87 87 88 88 By default, Linux will attempt to satisfy memory allocation requests from the
+1 -1
Documentation/watchdog/convert_drivers_to_kernel_api.txt
··· 213 213 Create a patch and send it to upstream 214 214 -------------------------------------- 215 215 216 - Make sure you understood Documentation/SubmittingPatches and send your patch to 216 + Make sure you understood Documentation/process/submitting-patches.rst and send your patch to 217 217 linux-watchdog@vger.kernel.org. We are looking forward to it :) 218 218
+1 -1
Documentation/watchdog/watchdog-parameters.txt
··· 4 4 file. 5 5 6 6 7 - See Documentation/kernel-parameters.txt for information on 7 + See Documentation/admin-guide/kernel-parameters.rst for information on 8 8 providing kernel parameters for builtin drivers versus loadable 9 9 modules. 10 10
+1 -1
Documentation/x86/boot.txt
··· 921 921 though not all of them are actually meaningful to the kernel. Boot 922 922 loader authors who need additional command line options for the boot 923 923 loader itself should get them registered in 924 - Documentation/kernel-parameters.txt to make sure they will not 924 + Documentation/admin-guide/kernel-parameters.rst to make sure they will not 925 925 conflict with actual kernel options now or in the future. 926 926 927 927 vga=<mode>
+3 -3
Documentation/zh_CN/CodingStyle
··· 1 - Chinese translated version of Documentation/CodingStyle 1 + Chinese translated version of Documentation/process/coding-style.rst 2 2 3 3 If you have any comment or update to the content, please post to LKML directly. 4 4 However, if you have problem communicating in English you can also ask the ··· 7 7 8 8 Chinese maintainer: Zhang Le <r0bertz@gentoo.org> 9 9 --------------------------------------------------------------------- 10 - Documentation/CodingStyle的中文翻译 10 + Documentation/process/coding-style.rst的中文翻译 11 11 12 12 如果想评论或更新本文的内容,请直接发信到LKML。如果你使用英文交流有困难的话,也可 13 13 以向中文版维护者求助。如果本翻译更新不及时或者翻译存在问题,请联系中文版维护者。 ··· 809 809 810 810 WG14是C语言的国际标准化工作组,URL: http://www.open-std.org/JTC1/SC22/WG14/ 811 811 812 - Kernel CodingStyle,作者 greg@kroah.com 发表于OLS 2002: 812 + Kernel process/coding-style.rst,作者 greg@kroah.com 发表于OLS 2002: 813 813 http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/
+15 -15
Documentation/zh_CN/HOWTO
··· 1 - Chinese translated version of Documentation/HOWTO 1 + Chinese translated version of Documentation/process/howto.rst 2 2 3 3 If you have any comment or update to the content, please contact the 4 4 original document maintainer directly. However, if you have a problem ··· 9 9 Maintainer: Greg Kroah-Hartman <greg@kroah.com> 10 10 Chinese maintainer: Li Yang <leoli@freescale.com> 11 11 --------------------------------------------------------------------- 12 - Documentation/HOWTO 的中文翻译 12 + Documentation/process/howto.rst 的中文翻译 13 13 14 14 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 15 15 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻 ··· 93 93 文件简要介绍了Linux内核的背景,并且描述了如何配置和编译内核。内核的 94 94 新用户应该从这里开始。 95 95 96 - Documentation/Changes 96 + Documentation/process/changes.rst 97 97 文件给出了用来编译和使用内核所需要的最小软件包列表。 98 98 99 - Documentation/CodingStyle 99 + Documentation/process/coding-style.rst 100 100 描述Linux内核的代码风格和理由。所有新代码需要遵守这篇文档中定义的规 101 101 范。大多数维护者只会接收符合规定的补丁,很多人也只会帮忙检查符合风格 102 102 的代码。 103 103 104 - Documentation/SubmittingPatches 105 - Documentation/SubmittingDrivers 104 + Documentation/process/submitting-patches.rst 105 + Documentation/process/submitting-drivers.rst 106 106 这两份文档明确描述如何创建和发送补丁,其中包括(但不仅限于): 107 107 - 邮件内容 108 108 - 邮件格式 ··· 116 116 "Linux kernel patch submission format" 117 117 http://linux.yyz.us/patch-format.html 118 118 119 - Documentation/stable_api_nonsense.txt 119 + Documentation/process/stable-api-nonsense.rst 120 120 论证内核为什么特意不包括稳定的内核内部API,也就是说不包括像这样的特 121 121 性: 122 122 - 子系统中间层(为了兼容性?) ··· 125 125 这篇文档对于理解Linux的开发哲学至关重要。对于将开发平台从其他操作系 126 126 统转移到Linux的人来说也很重要。 127 127 128 - Documentation/SecurityBugs 128 + Documentation/admin-guide/security-bugs.rst 129 129 如果你认为自己发现了Linux内核的安全性问题,请根据这篇文档中的步骤来 130 130 提醒其他内核开发者并帮助解决这个问题。 131 131 132 - Documentation/ManagementStyle 132 + Documentation/process/management-style.rst 133 133 描述内核维护者的工作方法及其共有特点。这对于刚刚接触内核开发(或者对 134 134 它感到好奇)的人来说很重要,因为它解释了很多对于内核维护者独特行为的 135 135 普遍误解与迷惑。 136 136 137 - Documentation/stable_kernel_rules.txt 137 + Documentation/process/stable-kernel-rules.rst 138 138 解释了稳定版内核发布的规则,以及如何将改动放入这些版本的步骤。 139 139 140 - Documentation/kernel-docs.txt 140 + Documentation/process/kernel-docs.rst 141 141 有助于内核开发的外部文档列表。如果你在内核自带的文档中没有找到你想找 142 142 的内容,可以查看这些文档。 143 143 144 - Documentation/applying-patches.txt 144 + Documentation/process/applying-patches.rst 145 145 关于补丁是什么以及如何将它打在不同内核开发分支上的好介绍 146 146 147 147 内核还拥有大量从代码自动生成的文档。它包含内核内部API的全面介绍以及如何 ··· 238 238 2.6.x.y版本由“稳定版”小组(邮件地址<stable@vger.kernel.org>)维护,一般隔周发 239 239 布新版本。 240 240 241 - 内核源码中的Documentation/stable_kernel_rules.txt文件具体描述了可被稳定 241 + 内核源码中的Documentation/process/stable-kernel-rules.rst文件具体描述了可被稳定 242 242 版内核接受的修改类型以及发布的流程。 243 243 244 244 ··· 329 329 户在这个工具中报告找到的所有bug。如何使用内核bugzilla的细节请访问: 330 330 http://test.kernel.org/bugzilla/faq.html 331 331 332 - 内核源码主目录中的REPORTING-BUGS文件里有一个很好的模板。它指导用户如何报 332 + 内核源码主目录中的admin-guide/reporting-bugs.rst文件里有一个很好的模板。它指导用户如何报 333 333 告可能的内核bug以及需要提供哪些信息来帮助内核开发者们找到问题的根源。 334 334 335 335 ··· 380 380 这几行。将你的评论加在被引用的段落之间而不要放在邮件的顶部。 381 381 382 382 如果你在邮件中附带补丁,请确认它们是可以直接阅读的纯文本(如 383 - Documentation/SubmittingPatches文档中所述)。内核开发者们不希望遇到附件 383 + Documentation/process/submitting-patches.rst文档中所述)。内核开发者们不希望遇到附件 384 384 或者被压缩了的补丁。只有这样才能保证他们可以直接评论你的每行代码。请确保 385 385 你使用的邮件发送程序不会修改空格和制表符。一个防范性的测试方法是先将邮件 386 386 发送给自己,然后自己尝试是否可以顺利地打上收到的补丁。如果测试不成功,请
+3 -3
Documentation/zh_CN/SecurityBugs
··· 1 - Chinese translated version of Documentation/SecurityBugs 1 + Chinese translated version of Documentation/admin-guide/security-bugs.rst 2 2 3 3 If you have any comment or update to the content, please contact the 4 4 original document maintainer directly. However, if you have a problem ··· 8 8 9 9 Chinese maintainer: Harry Wei <harryxiyou@gmail.com> 10 10 --------------------------------------------------------------------- 11 - Documentation/SecurityBugs 的中文翻译 11 + Documentation/admin-guide/security-bugs.rst 的中文翻译 12 12 13 13 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 14 14 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻 ··· 31 31 一组独立的安全工作人员,可以帮助改善漏洞报告并且公布和取消一个修复。安 32 32 全团队有可能会从部分的维护者那里引进额外的帮助来了解并且修复安全漏洞。 33 33 当遇到任何漏洞,所能提供的信息越多就越能诊断和修复。如果你不清楚什么 34 - 是有帮助的信息,那就请重温一下REPORTING-BUGS文件中的概述过程。任 34 + 是有帮助的信息,那就请重温一下admin-guide/reporting-bugs.rst文件中的概述过程。任 35 35 何攻击性的代码都是非常有用的,未经报告者的同意不会被取消,除非它已经 36 36 被公布于众。 37 37
+6 -6
Documentation/zh_CN/SubmittingDrivers
··· 1 - Chinese translated version of Documentation/SubmittingDrivers 1 + Chinese translated version of Documentation/process/submitting-drivers.rst 2 2 3 3 If you have any comment or update to the content, please contact the 4 4 original document maintainer directly. However, if you have a problem ··· 8 8 9 9 Chinese maintainer: Li Yang <leo@zh-kernel.org> 10 10 --------------------------------------------------------------------- 11 - Documentation/SubmittingDrivers 的中文翻译 11 + Documentation/process/submitting-drivers.rst 的中文翻译 12 12 13 13 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 14 14 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻 ··· 30 30 兴趣的是显卡驱动程序,你也许应该访问 XFree86 项目(http://www.xfree86.org/) 31 31 和/或 X.org 项目 (http://x.org)。 32 32 33 - 另请参阅 Documentation/SubmittingPatches 文档。 33 + 另请参阅 Documentation/process/submitting-patches.rst 文档。 34 34 35 35 36 36 分配设备号 ··· 39 39 块设备和字符设备的主设备号与从设备号是由 Linux 命名编号分配权威 LANANA( 40 40 现在是 Torben Mathiasen)负责分配。申请的网址是 http://www.lanana.org/。 41 41 即使不准备提交到主流内核的设备驱动也需要在这里分配设备号。有关详细信息, 42 - 请参阅 Documentation/devices.txt。 42 + 请参阅 Documentation/admin-guide/devices.rst。 43 43 44 44 如果你使用的不是已经分配的设备号,那么当你提交设备驱动的时候,它将会被强 45 45 制分配一个新的设备号,即便这个设备号和你之前发给客户的截然不同。 ··· 81 81 如果你需要一个 Linux 和 NT 的通用驱动接口,那么请在用 82 82 户空间实现它。 83 83 84 - 代码: 请使用 Documentation/CodingStyle 中所描述的 Linux 代码风 84 + 代码: 请使用 Documentation/process/coding-style.rst 中所描述的 Linux 代码风 85 85 格。如果你的某些代码段(例如那些与 Windows 驱动程序包共 86 86 享的代码段)需要使用其他格式,而你却只希望维护一份代码, 87 87 那么请将它们很好地区分出来,并且注明原因。 ··· 107 107 程序测试的指导,请参阅 108 108 Documentation/power/drivers-testing.txt。有关驱动程序电 109 109 源管理问题相对全面的概述,请参阅 110 - Documentation/power/devices.txt。 110 + Documentation/power/admin-guide/devices.rst。 111 111 112 112 管理: 如果一个驱动程序的作者还在进行有效的维护,那么通常除了那 113 113 些明显正确且不需要任何检查的补丁以外,其他所有的补丁都会
+7 -7
Documentation/zh_CN/SubmittingPatches
··· 1 - Chinese translated version of Documentation/SubmittingPatches 1 + Chinese translated version of Documentation/process/submitting-patches.rst 2 2 3 3 If you have any comment or update to the content, please contact the 4 4 original document maintainer directly. However, if you have a problem ··· 8 8 9 9 Chinese maintainer: TripleX Chung <triplex@zh-kernel.org> 10 10 --------------------------------------------------------------------- 11 - Documentation/SubmittingPatches 的中文翻译 11 + Documentation/process/submitting-patches.rst 的中文翻译 12 12 13 13 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 14 14 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻 ··· 30 30 对于想要将改动提交到 Linux 内核的个人或者公司来说,如果不熟悉“规矩”, 31 31 提交的流程会让人畏惧。本文档收集了一系列建议,这些建议可以大大的提高你 32 32 的改动被接受的机会。 33 - 阅读 Documentation/SubmitChecklist 来获得在提交代码前需要检查的项目的列 33 + 阅读 Documentation/process/submit-checklist.rst 来获得在提交代码前需要检查的项目的列 34 34 表。如果你在提交一个驱动程序,那么同时阅读一下 35 - Documentation/SubmittingDrivers 。 35 + Documentation/process/submitting-drivers.rst 。 36 36 37 37 38 38 -------------------------- ··· 338 338 本节包含很多和提交到内核的代码有关的通常的"规则"。事情永远有例外...但是 339 339 你必须真的有好的理由这样做。你可以把本节叫做Linus的计算机科学入门课。 340 340 341 - 1) 读 Document/CodingStyle 341 + 1) 读 Document/process/coding-style.rst 342 342 343 343 Nuff 说过,如果你的代码和这个偏离太多,那么它有可能会被拒绝,没有更多的 344 344 审查,没有更多的评价。 ··· 404 404 NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people! 405 405 <https://lkml.org/lkml/2005/7/11/336> 406 406 407 - Kernel Documentation/CodingStyle: 408 - <http://sosdg.org/~coywolf/lxr/source/Documentation/CodingStyle> 407 + Kernel Documentation/process/coding-style.rst: 408 + <http://sosdg.org/~coywolf/lxr/source/Documentation/process/coding-style.rst> 409 409 410 410 Linus Torvalds's mail on the canonical patch format: 411 411 <http://lkml.org/lkml/2005/4/7/183>
+1 -1
Documentation/zh_CN/arm/Booting
··· 68 68 作为替代方案,引导加载程序也可以通过标签列表传递相关的'console=' 69 69 选项给内核以指定某个串口,而串口数据格式的选项在以下文档中描述: 70 70 71 - Documentation/kernel-parameters.txt。 71 + Documentation/admin-guide/kernel-parameters.rst。 72 72 73 73 74 74 3、检测机器类型
+2 -2
Documentation/zh_CN/email-clients.txt
··· 1 - Chinese translated version of Documentation/email-clients.txt 1 + Chinese translated version of Documentation/process/email-clients.rst 2 2 3 3 If you have any comment or update to the content, please contact the 4 4 original document maintainer directly. However, if you have a problem ··· 8 8 9 9 Chinese maintainer: Harry Wei <harryxiyou@gmail.com> 10 10 --------------------------------------------------------------------- 11 - Documentation/email-clients.txt 的中文翻译 11 + Documentation/process/email-clients.rst 的中文翻译 12 12 13 13 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 14 14 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻
+3 -3
Documentation/zh_CN/oops-tracing.txt
··· 1 - Chinese translated version of Documentation/oops-tracing.txt 1 + Chinese translated version of Documentation/admin-guide/oops-tracing.rst 2 2 3 3 If you have any comment or update to the content, please contact the 4 4 original document maintainer directly. However, if you have a problem ··· 8 8 9 9 Chinese maintainer: Dave Young <hidave.darkstar@gmail.com> 10 10 --------------------------------------------------------------------- 11 - Documentation/oops-tracing.txt 的中文翻译 11 + Documentation/admin-guide/oops-tracing.rst 的中文翻译 12 12 13 13 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 14 14 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻 ··· 50 50 息滚动到了终端的上面,你会发现以高分辩率启动(比如,vga=791)会让你读到更多的文 51 51 本。(注意:这需要vesafb,所以对‘早期’的oops没有帮助) 52 52 53 - (2)用串口终端启动(请参看Documentation/serial-console.txt),运行一个null 53 + (2)用串口终端启动(请参看Documentation/admin-guide/serial-console.rst),运行一个null 54 54 modem到另一台机器并用你喜欢的通讯工具获取输出。Minicom工作地很好。 55 55 56 56 (3)使用Kdump(请参看Documentation/kdump/kdump.txt),
+2 -2
Documentation/zh_CN/stable_api_nonsense.txt
··· 1 - Chinese translated version of Documentation/stable_api_nonsense.txt 1 + Chinese translated version of Documentation/process/stable-api-nonsense.rst 2 2 3 3 If you have any comment or update to the content, please contact the 4 4 original document maintainer directly. However, if you have problem ··· 9 9 Maintainer: Greg Kroah-Hartman <greg@kroah.com> 10 10 Chinese maintainer: TripleX Chung <zhongyu@18mail.cn> 11 11 --------------------------------------------------------------------- 12 - Documentation/stable_api_nonsense.txt 的中文翻译 12 + Documentation/process/stable-api-nonsense.rst 的中文翻译 13 13 14 14 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 15 15 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻
+3 -3
Documentation/zh_CN/stable_kernel_rules.txt
··· 1 - Chinese translated version of Documentation/stable_kernel_rules.txt 1 + Chinese translated version of Documentation/process/stable-kernel-rules.rst 2 2 3 3 If you have any comment or update to the content, please contact the 4 4 original document maintainer directly. However, if you have a problem ··· 8 8 9 9 Chinese maintainer: TripleX Chung <triplex@zh-kernel.org> 10 10 --------------------------------------------------------------------- 11 - Documentation/stable_kernel_rules.txt 的中文翻译 11 + Documentation/process/stable-kernel-rules.rst 的中文翻译 12 12 13 13 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 14 14 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻 ··· 38 38 - 没有“理论上的竞争条件”,除非能给出竞争条件如何被利用的解释。 39 39 - 不能存在任何的“琐碎的”修正(拼写修正,去掉多余空格之类的)。 40 40 - 必须被相关子系统的维护者接受。 41 - - 必须遵循Documentation/SubmittingPatches里的规则。 41 + - 必须遵循Documentation/process/submitting-patches.rst里的规则。 42 42 43 43 向稳定版代码树提交补丁的过程: 44 44
+2 -2
Documentation/zh_CN/volatile-considered-harmful.txt
··· 1 - Chinese translated version of Documentation/volatile-considered-harmful.txt 1 + Chinese translated version of Documentation/process/volatile-considered-harmful.rst 2 2 3 3 If you have any comment or update to the content, please contact the 4 4 original document maintainer directly. However, if you have a problem ··· 9 9 Maintainer: Jonathan Corbet <corbet@lwn.net> 10 10 Chinese maintainer: Bryan Wu <bryan.wu@analog.com> 11 11 --------------------------------------------------------------------- 12 - Documentation/volatile-considered-harmful.txt 的中文翻译 12 + Documentation/process/volatile-considered-harmful.rst 的中文翻译 13 13 14 14 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 15 15 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻
+5 -5
MAINTAINERS
··· 35 35 36 36 PLEASE check your patch with the automated style checker 37 37 (scripts/checkpatch.pl) to catch trivial style violations. 38 - See Documentation/CodingStyle for guidance here. 38 + See Documentation/process/coding-style.rst for guidance here. 39 39 40 40 PLEASE CC: the maintainers and mailing lists that are generated 41 41 by scripts/get_maintainer.pl. The results returned by the 42 42 script will be best if you have git installed and are making 43 43 your changes in a branch derived from Linus' latest git tree. 44 - See Documentation/SubmittingPatches for details. 44 + See Documentation/process/submitting-patches.rst for details. 45 45 46 46 PLEASE try to include any credit lines you want added with the 47 47 patch. It avoids people being missed off by mistake and makes ··· 54 54 of the Linux Foundation certificate of contribution and should 55 55 include a Signed-off-by: line. The current version of this 56 56 "Developer's Certificate of Origin" (DCO) is listed in the file 57 - Documentation/SubmittingPatches. 57 + Documentation/process/submitting-patches.rst. 58 58 59 59 6. Make sure you have the right to send any changes you make. If you 60 60 do changes at work you may find your employer owns the patch ··· 2924 2924 M: Kevin Tsai <ktsai@capellamicro.com> 2925 2925 S: Maintained 2926 2926 F: drivers/iio/light/cm* 2927 - F: Documentation/devicetree/bindings/i2c/trivial-devices.txt 2927 + F: Documentation/devicetree/bindings/i2c/trivial-admin-guide/devices.rst 2928 2928 2929 2929 CAVIUM I2C DRIVER 2930 2930 M: Jan Glauber <jglauber@cavium.com> ··· 11438 11438 M: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 11439 11439 L: stable@vger.kernel.org 11440 11440 S: Supported 11441 - F: Documentation/stable_kernel_rules.txt 11441 + F: Documentation/process/stable-kernel-rules.rst 11442 11442 11443 11443 STAGING SUBSYSTEM 11444 11444 M: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
+1 -1
arch/x86/Kconfig
··· 1525 1525 line. By default it scans the low 64k of memory every 60 1526 1526 seconds; see the memory_corruption_check_size and 1527 1527 memory_corruption_check_period parameters in 1528 - Documentation/kernel-parameters.txt to adjust this. 1528 + Documentation/admin-guide/kernel-parameters.rst to adjust this. 1529 1529 1530 1530 When enabled with the default parameters, this option has 1531 1531 almost no overhead, as it reserves a relatively small amount
+1 -1
drivers/acpi/Kconfig
··· 342 342 343 343 Use the acpi.debug_layer and acpi.debug_level kernel command-line 344 344 parameters documented in Documentation/acpi/debug.txt and 345 - Documentation/kernel-parameters.txt to control the type and 345 + Documentation/admin-guide/kernel-parameters.rst to control the type and 346 346 amount of debug output. 347 347 348 348 config ACPI_PCI_SLOT
+1 -1
drivers/ata/libata-core.c
··· 129 129 static char ata_force_param_buf[PAGE_SIZE] __initdata; 130 130 /* param_buf is thrown away after initialization, disallow read */ 131 131 module_param_string(force, ata_force_param_buf, sizeof(ata_force_param_buf), 0); 132 - MODULE_PARM_DESC(force, "Force ATA configurations including cable type, link speed and transfer mode (see Documentation/kernel-parameters.txt for details)"); 132 + MODULE_PARM_DESC(force, "Force ATA configurations including cable type, link speed and transfer mode (see Documentation/admin-guide/kernel-parameters.rst for details)"); 133 133 134 134 static int atapi_enabled = 1; 135 135 module_param(atapi_enabled, int, 0444);
+2 -2
drivers/char/pcmcia/cm4000_cs.c
··· 14 14 * (C) 2000,2001,2002,2003,2004 Omnikey AG 15 15 * 16 16 * (C) 2005-2006 Harald Welte <laforge@gnumonks.org> 17 - * - Adhere to Kernel CodingStyle 17 + * - Adhere to Kernel process/coding-style.rst 18 18 * - Port to 2.6.13 "new" style PCMCIA 19 19 * - Check for copy_{from,to}_user return values 20 20 * - Use nonseekable_open() ··· 151 151 static struct class *cmm_class; 152 152 153 153 /* This table doesn't use spaces after the comma between fields and thus 154 - * violates CodingStyle. However, I don't really think wrapping it around will 154 + * violates process/coding-style.rst. However, I don't really think wrapping it around will 155 155 * make it any clearer to read -HW */ 156 156 static unsigned char fi_di_table[10][14] = { 157 157 /*FI 00 01 02 03 04 05 06 07 08 09 10 11 12 13 */
+1 -1
drivers/net/can/grcan.c
··· 15 15 * See "Documentation/ABI/testing/sysfs-class-net-grcan" for information on the 16 16 * sysfs interface. 17 17 * 18 - * See "Documentation/kernel-parameters.txt" for information on the module 18 + * See "Documentation/admin-guide/kernel-parameters.rst" for information on the module 19 19 * parameters. 20 20 * 21 21 * This program is free software; you can redistribute it and/or modify it
+1 -1
drivers/nvdimm/Kconfig
··· 28 28 non-standard OEM-specific E820 memory type (type-12, see 29 29 CONFIG_X86_PMEM_LEGACY), or it is manually specified by the 30 30 'memmap=nn[KMG]!ss[KMG]' kernel command line (see 31 - Documentation/kernel-parameters.txt). This driver converts 31 + Documentation/admin-guide/kernel-parameters.rst). This driver converts 32 32 these persistent memory ranges into block devices that are 33 33 capable of DAX (direct-access) file system mappings. See 34 34 Documentation/nvdimm/nvdimm.txt for more details.
+1 -1
drivers/staging/vme/devices/vme_user.c
··· 47 47 static int bus[VME_USER_BUS_MAX]; 48 48 static unsigned int bus_num; 49 49 50 - /* Currently Documentation/devices.txt defines the following for VME: 50 + /* Currently Documentation/admin-guide/devices.rst defines the following for VME: 51 51 * 52 52 * 221 char VME bus 53 53 * 0 = /dev/bus/vme/m0 First master image
+4 -4
drivers/video/fbdev/skeletonfb.c
··· 836 836 * @dev: PCI device 837 837 * @msg: the suspend event code. 838 838 * 839 - * See Documentation/power/devices.txt for more information 839 + * See Documentation/power/admin-guide/devices.rst for more information 840 840 */ 841 841 static int xxxfb_suspend(struct pci_dev *dev, pm_message_t msg) 842 842 { ··· 851 851 * xxxfb_resume - Optional but recommended function. Resume the device. 852 852 * @dev: PCI device 853 853 * 854 - * See Documentation/power/devices.txt for more information 854 + * See Documentation/power/admin-guide/devices.rst for more information 855 855 */ 856 856 static int xxxfb_resume(struct pci_dev *dev) 857 857 { ··· 915 915 * @dev: platform device 916 916 * @msg: the suspend event code. 917 917 * 918 - * See Documentation/power/devices.txt for more information 918 + * See Documentation/power/admin-guide/devices.rst for more information 919 919 */ 920 920 static int xxxfb_suspend(struct platform_device *dev, pm_message_t msg) 921 921 { ··· 930 930 * xxxfb_resume - Optional but recommended function. Resume the device. 931 931 * @dev: platform device 932 932 * 933 - * See Documentation/power/devices.txt for more information 933 + * See Documentation/power/admin-guide/devices.rst for more information 934 934 */ 935 935 static int xxxfb_resume(struct platform_dev *dev) 936 936 {
+1 -1
drivers/virtio/Kconfig
··· 75 75 Allow virtio-mmio devices instantiation via the kernel command line 76 76 or module parameters. Be aware that using incorrect parameters (base 77 77 address in particular) can crash your system - you have been warned. 78 - See Documentation/kernel-parameters.txt for details. 78 + See Documentation/admin-guide/kernel-parameters.rst for details. 79 79 80 80 If unsure, say 'N'. 81 81
+2 -2
fs/Kconfig.binfmt
··· 170 170 171 171 You can do other nice things, too. Read the file 172 172 <file:Documentation/binfmt_misc.txt> to learn how to use this 173 - feature, <file:Documentation/java.txt> for information about how 174 - to include Java support. and <file:Documentation/mono.txt> for 173 + feature, <file:Documentation/admin-guide/java.rst> for information about how 174 + to include Java support. and <file:Documentation/admin-guide/mono.rst> for 175 175 information about how to include Mono-based .NET support. 176 176 177 177 To use binfmt_misc, you will need to mount it:
+1 -1
fs/pstore/Kconfig
··· 86 86 Note that for historical reasons, the module will be named 87 87 "ramoops.ko". 88 88 89 - For more information, see Documentation/ramoops.txt. 89 + For more information, see Documentation/admin-guide/ramoops.rst.
+1 -1
include/linux/device.h
··· 733 733 * minimizes board-specific #ifdefs in drivers. 734 734 * @driver_data: Private pointer for driver specific info. 735 735 * @power: For device power management. 736 - * See Documentation/power/devices.txt for details. 736 + * See Documentation/power/admin-guide/devices.rst for details. 737 737 * @pm_domain: Provide callbacks that are executed during system suspend, 738 738 * hibernation, system resume and during runtime PM transitions 739 739 * along with subsystem-level and driver-level callbacks.
+1 -1
include/linux/pm.h
··· 258 258 * example, if it detects that a child was unplugged while the system was 259 259 * asleep). 260 260 * 261 - * Refer to Documentation/power/devices.txt for more information about the role 261 + * Refer to Documentation/power/admin-guide/devices.rst for more information about the role 262 262 * of the above callbacks in the system suspend process. 263 263 * 264 264 * There also are callbacks related to runtime power management of devices.
+1 -1
include/uapi/linux/major.h
··· 3 3 4 4 /* 5 5 * This file has definitions for major device numbers. 6 - * For the device number assignments, see Documentation/devices.txt. 6 + * For the device number assignments, see Documentation/admin-guide/devices.rst. 7 7 */ 8 8 9 9 #define UNNAMED_MAJOR 0
+1 -1
init/Kconfig
··· 1306 1306 boot loader (loadlin or lilo) and that is mounted as root 1307 1307 before the normal boot procedure. It is typically used to 1308 1308 load modules needed to mount the "real" root file system, 1309 - etc. See <file:Documentation/initrd.txt> for details. 1309 + etc. See <file:Documentation/admin-guide/initrd.rst> for details. 1310 1310 1311 1311 If RAM disk support (BLK_DEV_RAM) is also included, this 1312 1312 also enables initial RAM disk (initrd) support and adds
+1 -1
init/main.c
··· 980 980 return 0; 981 981 982 982 panic("No working init found. Try passing init= option to kernel. " 983 - "See Linux Documentation/init.txt for guidance."); 983 + "See Linux Documentation/admin-guide/init.rst for guidance."); 984 984 } 985 985 986 986 static noinline void __init kernel_init_freeable(void)
+1 -1
lib/Kconfig.debug
··· 13 13 be included, not that the timestamp is recorded. 14 14 15 15 The behavior is also controlled by the kernel command line 16 - parameter printk.time=1. See Documentation/kernel-parameters.txt 16 + parameter printk.time=1. See Documentation/admin-guide/kernel-parameters.rst 17 17 18 18 config MESSAGE_LOGLEVEL_DEFAULT 19 19 int "Default message log level (1-7)"
+3 -3
scripts/checkpatch.pl
··· 2187 2187 2188 2188 if ($rawline=~/^\+\+\+\s+(\S+)/) { 2189 2189 $setup_docs = 0; 2190 - if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 2190 + if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) { 2191 2191 $setup_docs = 1; 2192 2192 } 2193 2193 #next; ··· 5102 5102 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 5103 5103 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5104 5104 WARN("VOLATILE", 5105 - "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 5105 + "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 5106 5106 } 5107 5107 5108 5108 # Check for user-visible strings broken across lines, which breaks the ability ··· 5817 5817 5818 5818 if (!grep(/$name/, @setup_docs)) { 5819 5819 CHK("UNDOCUMENTED_SETUP", 5820 - "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 5820 + "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr); 5821 5821 } 5822 5822 } 5823 5823
+1 -1
tools/testing/selftests/futex/README
··· 59 59 Coding Style 60 60 ------------ 61 61 o The Futex Test project adheres to the coding standards set forth by Linux 62 - kernel as defined in the Linux source Documentation/CodingStyle. 62 + kernel as defined in the Linux source Documentation/process/coding-style.rst.