Commit 8c27ceff authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

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: default avatarMauro Carvalho Chehab <>
parent 9d85025b
......@@ -15,11 +15,11 @@ Following translations are available on the WWW:
- info on kernel <-> userspace ABI and relative interface stability.
- brute force method of doing binary search of patches to find bug.
- list of changes that break older software packages.
- how the maintainers expect the C code in the kernel to look.
- DMA API, pci_ API & extensions for non-consistent memory machines.
......@@ -33,7 +33,7 @@ DocBook/
- directory with DocBook templates etc. for kernel documentation.
- directory with info on customizing EDID for broken gfx/displays.
- the process and procedures of how to do Linux kernel development.
- info on Linux Intelligent Platform Management Interface (IPMI) Driver.
......@@ -48,7 +48,7 @@ Intel-IOMMU.txt
- This file does nothing. Removing it breaks make htmldocs and
make distclean.
- how to (attempt to) manage kernel hackers.
- directory with info on RCU (read-copy update).
......@@ -56,13 +56,13 @@ SAK.txt
- info on Secure Attention Keys.
- Silicon Motion SM501 multimedia companion chip
- procedure for reporting security bugs found in the kernel.
- Linux kernel patch submission checklist.
- procedure to get a new driver source included into the kernel tree.
- procedure to get a source patch included into the kernel tree.
- how to change your VGA cursor from a blinking underscore.
......@@ -72,7 +72,7 @@ acpi/
- info on ACPI-specific hooks in the kernel.
- description of AoE (ATA over Ethernet) along with config examples.
- description of various trees and how to apply their patches.
- directory with info about Linux on the ARM architecture.
......@@ -86,7 +86,7 @@ auxdisplay/
- misc. LCD driver documentation (cfag12864b, ks0108).
- directory with info on controlling backlights in flat panel displays
- how to use kernel parameters to exclude bad RAM regions.
- basic instructions for those who wants to profile Linux kernel.
......@@ -154,7 +154,7 @@ process/
- how to work with the mainline kernel development process.
- directory with info on Device Mapper.
- plain ASCII listing of all the nodes in /dev/ with major minor #'s.
- directory with info on device tree files used by OF/PowerPC/ARM
......@@ -178,7 +178,7 @@ efi-stub.txt
- How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
- info on EISA bus support.
- info on how to use e-mail to send un-mangled (git) patches.
- directory with porting guide for Android kernel switch driver.
......@@ -226,9 +226,9 @@ ia64/
- directory with info about Linux on Intel 64 bit architecture.
- directory with documents concerning Linux InfiniBand support.
- what to do when the kernel can't find the 1st process to run.
- how to use the RAM disk as an initial/temporary root filesystem.
- info on Linux input device support.
......@@ -248,7 +248,7 @@ isapnp.txt
- info on Linux ISA Plug & Play support.
- directory with info on the Linux ISDN support, and supported cards.
- info on the in-kernel binary support for Java(tm).
- directory with Japanese translations of various documents
......@@ -256,11 +256,11 @@ kbuild/
- directory with info about the kernel build process.
- directory with mini HowTo on getting the crash dump code to work.
- listing of various WWW + books that document kernel internals.
- how to write and format reStructuredText kernel documentation
- summary listing of command line / boot prompt args for the kernel.
- List of all per-CPU kthreads and how they introduce jitter.
......@@ -302,7 +302,7 @@ magic-number.txt
- list of magic numbers used to mark/protect kernel data structures.
- How to write drivers for the common mailbox framework (IPC).
- info on boot arguments for the multiple devices driver.
- info on media framework, its data structures, functions and usage.
......@@ -326,7 +326,7 @@ module-signing.txt
- Kernel module signing for increased security when loading modules.
- directory with info about memory technology devices (flash)
- how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
- directory with various information about namespaces
......@@ -340,7 +340,7 @@ nommu-mmap.txt
- documentation about no-mmu memory mapping support.
- info on how to read Numa policy hit/miss statistics in sysfs.
- how to decode those nasty internal kernel error dump messages.
- An introduction to the "padata" parallel execution API
......@@ -378,7 +378,7 @@ ptp/
- directory with info on support for IEEE 1588 PTP clocks in Linux.
- info on the pulse width modulation driver subsystem
- documentation of the ramoops oops/panic logging module.
- directory with info on RapidIO packet-based fabric interconnect
......@@ -406,7 +406,7 @@ security/
- directory that contains security-related info
- directory with info on the low level serial API.
- how to set up Linux with a serial line console as the default.
- description of the SGI IOC4 PCI (multi function) device.
......@@ -420,9 +420,9 @@ sparse.txt
- info on how to obtain and use the sparse tool for typechecking.
- overview of Linux kernel Serial Peripheral Interface (SPI) support.
- info on why the kernel does not have a stable in-kernel api or abi.
- rules and procedures for the -stable kernel releases.
- info on how static keys allow debug code in hotpaths via patching
......@@ -444,7 +444,7 @@ trace/
- directory with info on tracing technologies within linux
- info on how to avoid arch breaking unaligned memory access in code.
- info on the Unicode character/font mapping used in Linux.
- description of the Linux unshare system call.
......@@ -466,7 +466,7 @@ vm/
- directory with info on the Linux vm code.
- file relating info on the VME bus API in linux
- Why the "volatile" type class should not be used
- directory with documents regarding the 1-wire (w1) subsystem.
......@@ -84,4 +84,4 @@ stable:
- Kernel-internal symbols. Do not rely on the presence, absence, location, or
type of any kernel symbol, either in files or the kernel binary
itself. See Documentation/stable_api_nonsense.txt.
itself. See Documentation/process/stable-api-nonsense.rst.
......@@ -347,7 +347,7 @@ Description:
because of fragmentation, SLUB will retry with the minimum order
possible depending on its characteristics.
When debug_guardpage_minorder=N (N > 0) parameter is specified
(see Documentation/kernel-parameters.txt), the minimum possible
(see Documentation/admin-guide/kernel-parameters.rst), the minimum possible
order is used and this sysfs entry can not be used to change
the order at run time.
......@@ -1208,8 +1208,8 @@ static struct block_device_operations opt_fops = {
Finally, don't forget to read <filename>Documentation/SubmittingPatches</filename>
and possibly <filename>Documentation/SubmittingDrivers</filename>.
Finally, don't forget to read <filename>Documentation/process/submitting-patches.rst</filename>
and possibly <filename>Documentation/process/submitting-drivers.rst</filename>.
......@@ -101,6 +101,6 @@ received a notification, it will set the backlight level accordingly. This does
not affect the sending of event to user space, they are always sent to user
space regardless of whether or not the video module controls the backlight level
directly. This behaviour can be controlled through the brightness_switch_enabled
module parameter as documented in kernel-parameters.txt. It is recommended to
module parameter as documented in admin-guide/kernel-parameters.rst. It is recommended to
disable this behaviour once a GUI environment starts up and wants to have full
control of the backlight level.
......@@ -50,7 +50,8 @@ Documentation
- There are various README files in the Documentation/ subdirectory:
these typically contain kernel-specific installation notes for some
drivers for example. See Documentation/00-INDEX for a list of what
is contained in each file. Please read the Changes file, as it
is contained in each file. Please read the
:ref:`Documentation/process/changes.rst <changes>` file, as it
contains information about the problems, which may result by upgrading
your kernel.
......@@ -96,7 +97,7 @@ Installing the kernel source
and 4.0.2 patches. Similarly, if you are running kernel version 4.0.2 and
want to jump to 4.0.3, you must first reverse the 4.0.2 patch (that is,
patch -R) **before** applying the 4.0.3 patch. You can read more on this in
:ref:`Documentation/applying-patches.txt <applying_patches>`.
:ref:`Documentation/process/applying-patches.rst <applying_patches>`.
Alternatively, the script patch-kernel can be used to automate this
process. It determines the current kernel version and applies any
......@@ -120,7 +121,7 @@ Software requirements
Compiling and running the 4.x kernels requires up-to-date
versions of various software packages. Consult
:ref:`Documentation/Changes <changes>` for the minimum version numbers
:ref:`Documentation/process/changes.rst <changes>` for the minimum version numbers
required and how to get updates for these packages. Beware that using
excessively old versions of these packages can cause indirect
errors that are very difficult to track down, so don't assume that
......@@ -254,7 +255,7 @@ Compiling the kernel
- Make sure you have at least gcc 3.2 available.
For more information, refer to :ref:`Documentation/Changes <changes>`.
For more information, refer to :ref:`Documentation/process/changes.rst <changes>`.
Please note that you can still run a.out user programs with this kernel.
......@@ -355,7 +356,7 @@ If something goes wrong
help debugging the problem. The text above the dump is also
important: it tells something about why the kernel dumped code (in
the above example, it's due to a bad kernel pointer). More information
on making sense of the dump is in Documentation/oops-tracing.txt
on making sense of the dump is in Documentation/admin-guide/oops-tracing.rst
- If you compiled the kernel with CONFIG_KALLSYMS you can send the dump
as is, otherwise you will have to use the ``ksymoops`` program to make
......@@ -393,7 +394,7 @@ If something goes wrong
If you for some reason cannot do the above (you have a pre-compiled
kernel image or similar), telling me as much about your setup as
possible will help. Please read the :ref:`REPORTING-BUGS <reportingbugs>`
possible will help. Please read the :ref:`admin-guide/reporting-bugs.rst <reportingbugs>`
document for details.
- Alternatively, you can use gdb on a running kernel. (read-only; i.e. you
......@@ -33,7 +33,7 @@ memmap is already in the kernel and usable as kernel-parameter at
boot-time. Its syntax is slightly strange and you may need to
calculate the values by yourself!
Syntax to exclude a memory area (see kernel-parameters.txt for details)::
Syntax to exclude a memory area (see admin-guide/kernel-parameters.rst for details)::
......@@ -124,7 +124,7 @@ A few examples (assumed you are in ``/proc/sys/fs/binfmt_misc``):
echo ':DOSWin:M::MZ::/usr/local/bin/wine:' > register
For java support see Documentation/java.txt
For java support see Documentation/admin-guide/java.rst
You can enable/disable binfmt_misc or one binary type by echoing 0 (to disable)
......@@ -140,7 +140,7 @@ Hints
If you want to pass special arguments to your interpreter, you can
write a wrapper script for it. See Documentation/java.txt for an
write a wrapper script for it. See Documentation/admin-guide/java.rst for an
Your interpreter should NOT look in the PATH for the filename; the kernel
......@@ -3,7 +3,7 @@ Linux Braille Console
To get early boot messages on a braille device (before userspace screen
readers can start), you first need to compile the support for the usual serial
console (see :ref:`Documentation/serial-console.txt <serial_console>`), and
console (see :ref:`Documentation/admin-guide/serial-console.rst <serial_console>`), and
for braille device
(in :menuselection:`Device Drivers --> Accessibility support --> Console on braille device`).
......@@ -13,7 +13,7 @@ format is::
where ``serial_options...`` are the same as described in
:ref:`Documentation/serial-console.txt <serial_console>`.
:ref:`Documentation/admin-guide/serial-console.rst <serial_console>`.
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
override the baud rate to 115200, etc.
......@@ -31,7 +31,7 @@ parameter.
For simplicity, only one braille console can be enabled, other uses of
``console=brl,...`` will be discarded. Also note that it does not interfere with
the console selection mechanism described in
:ref:`Documentation/serial-console.txt <serial_console>`.
:ref:`Documentation/admin-guide/serial-console.rst <serial_console>`.
For now, only the VisioBraille device is supported.
......@@ -15,7 +15,7 @@ give up. Report as much as you have found to the relevant maintainer. See
MAINTAINERS for who that is for the subsystem you have worked on.
Before you submit a bug report read
:ref:`Documentation/REPORTING-BUGS <reportingbugs>`.
:ref:`Documentation/admin-guide/reporting-bugs.rst <reportingbugs>`.
Devices not appearing
......@@ -244,5 +244,6 @@ Once you have worked out a fix please submit it upstream. After all open
source is about sharing what you do and don't you want to be recognised for
your genius?
Please do read :ref:`Documentation/SubmittingPatches <submittingpatches>`
though to help your code get accepted.
Please do read
ref:`Documentation/process/submitting-patches.rst <submittingpatches>` though
to help your code get accepted.
......@@ -10,7 +10,7 @@ The LaTeX version of this document is no longer maintained, nor is
the document that used to reside at This version in the
mainline Linux kernel is the master document. Updates shall be sent
as patches to the kernel maintainers (see the
:ref:`Documentation/SubmittingPatches <submittingpatches>` document).
:ref:`Documentation/process/submitting-patches.rst <submittingpatches>` document).
Specifically explore the sections titled "CHAR and MISC DRIVERS", and
"BLOCK LAYER" in the MAINTAINERS file to find the right maintainers
to involve for character and block devices.
......@@ -815,7 +815,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted::
bits, and "f" is flow control ("r" for RTS or
omit it). Default is "9600n8".
See Documentation/serial-console.txt for more
See Documentation/admin-guide/serial-console.rst for more
information. See
Documentation/networking/netconsole.txt for an
......@@ -2239,7 +2239,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted::
mce=option [X86-64] See Documentation/x86/x86_64/boot-options.txt
md= [HW] RAID subsystems devices and level
See Documentation/md.txt.
See Documentation/admin-guide/md.rst.
mdacon= [MDA]
Format: <first>,<last>
......@@ -3322,7 +3322,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted::
r128= [HW,DRM]
raid= [HW,RAID]
See Documentation/md.txt.
See Documentation/admin-guide/md.rst.
ramdisk_size= [RAM] Sizes of RAM disks in kilobytes
See Documentation/blockdev/ramdisk.txt.
......@@ -44,7 +44,7 @@ the disk is not available then you have three options :
so won't help for 'early' oopses)
(2) Boot with a serial console (see
:ref:`Documentation/serial-console.txt <serial_console>`),
:ref:`Documentation/admin-guide/serial-console.rst <serial_console>`),
run a null modem to a second machine and capture the output there
using your favourite communication program. Minicom works well.
......@@ -61,7 +61,7 @@ Setting the ramoops parameters can be done in several different manners:
mem=128M ramoops.mem_address=0x8000000 ramoops.ecc=1
B. Use Device Tree bindings, as described in
For example::
reserved-memory {
......@@ -61,7 +61,7 @@ files to the script::
If it is a security bug, please copy the Security Contact listed in the
MAINTAINERS file. They can help coordinate bugfix and disclosure. See
:ref:`Documentation/SecurityBugs <securitybugs>` for more information.
:ref:`Documentation/admin-guide/security-bugs.rst <securitybugs>` for more information.
If you can't figure out which subsystem caused the issue, you should file
a bug in bugzilla and send email to
......@@ -94,7 +94,7 @@ step-by-step instructions for how a user can trigger the bug.
If the failure includes an "OOPS:", take a picture of the screen, capture
a netconsole trace, or type the message from your screen into the bug
report. Please read "Documentation/oops-tracing.txt" before posting your
report. Please read "Documentation/admin-guide/oops-tracing.rst" before posting your
bug report. This explains what you should do with the "Oops" information
to make it useful to the recipient.
......@@ -120,7 +120,7 @@ summary from [1.]>" for easy identification by the developers::
[4.2.] Kernel .config file:
[5.] Most recent kernel version which did not have the bug:
[6.] Output of Oops.. message (if applicable) with symbolic information
resolved (see Documentation/oops-tracing.txt)
resolved (see Documentation/admin-guide/oops-tracing.rst)
[7.] A small shell script or example program which triggers the
problem (if possible)
[8.] Environment
......@@ -19,7 +19,7 @@ area maintainers to understand and fix the security vulnerability.
As it is with any bug, the more information provided the easier it
will be to diagnose and fix. Please review the procedure outlined in
REPORTING-BUGS if you are unclear about what information is helpful.
admin-guide/reporting-bugs.rst if you are unclear about what information is helpful.
Any exploit code is very helpful and will not be released without
consent from the reporter unless it has already been made public.
......@@ -7,7 +7,7 @@ This file is maintained by H. Peter Anvin <> as part
of the Linux Assigned Names And Numbers Authority (LANANA) project.
The current version can be found at:
......@@ -51,7 +51,7 @@ As an alternative, the boot loader can pass the relevant 'console='
option to the kernel via the tagged lists specifying the port, and
serial format options as described in
3. Detect the machine type
......@@ -16,7 +16,7 @@ will fail. Something like the following should suffice:
typedef struct { long counter; } atomic_long_t;
Historically, counter has been declared volatile. This is now discouraged.
See Documentation/volatile-considered-harmful.txt for the complete rationale.
See Documentation/process/volatile-considered-harmful.rst for the complete rationale.
local_t is very similar to atomic_t. If the counter is per CPU and only
updated by one CPU, local_t is probably more appropriate. Please see
......@@ -14,7 +14,7 @@ Contents:
The RAM disk driver is a way to use main system memory as a block device. It
is required for initrd, an initial filesystem used if you need to load modules
in order to access the root filesystem (see Documentation/initrd.txt). It can
in order to access the root filesystem (see Documentation/admin-guide/initrd.rst). It can
also be used for a temporary filesystem for crypto work, since the contents
are erased on reboot.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment