Skip to content

Commit 8c27cef

Browse files
mchehabmchehab
committed
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>
1 parent 9d85025 commit 8c27cef

103 files changed

Lines changed: 280 additions & 278 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Documentation/00-INDEX‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Following translations are available on the WWW:
1515
ABI/
1616
- info on kernel <-> userspace ABI and relative interface stability.
1717

18-
BUG-HUNTING
18+
admin-guide/bug-hunting.rst
1919
- brute force method of doing binary search of patches to find bug.
20-
Changes
20+
process/changes.rst
2121
- list of changes that break older software packages.
22-
CodingStyle
22+
process/coding-style.rst
2323
- how the maintainers expect the C code in the kernel to look.
2424
DMA-API.txt
2525
- DMA API, pci_ API & extensions for non-consistent memory machines.
@@ -33,7 +33,7 @@ DocBook/
3333
- directory with DocBook templates etc. for kernel documentation.
3434
EDID/
3535
- directory with info on customizing EDID for broken gfx/displays.
36-
HOWTO
36+
process/howto.rst
3737
- the process and procedures of how to do Linux kernel development.
3838
IPMI.txt
3939
- info on Linux Intelligent Platform Management Interface (IPMI) Driver.
@@ -48,21 +48,21 @@ Intel-IOMMU.txt
4848
Makefile
4949
- This file does nothing. Removing it breaks make htmldocs and
5050
make distclean.
51-
ManagementStyle
51+
process/management-style.rst
5252
- how to (attempt to) manage kernel hackers.
5353
RCU/
5454
- directory with info on RCU (read-copy update).
5555
SAK.txt
5656
- info on Secure Attention Keys.
5757
SM501.txt
5858
- Silicon Motion SM501 multimedia companion chip
59-
SecurityBugs
59+
admin-guide/security-bugs.rst
6060
- procedure for reporting security bugs found in the kernel.
61-
SubmitChecklist
61+
process/submit-checklist.rst
6262
- Linux kernel patch submission checklist.
63-
SubmittingDrivers
63+
process/submitting-drivers.rst
6464
- procedure to get a new driver source included into the kernel tree.
65-
SubmittingPatches
65+
process/submitting-patches.rst
6666
- procedure to get a source patch included into the kernel tree.
6767
VGA-softcursor.txt
6868
- how to change your VGA cursor from a blinking underscore.
@@ -72,7 +72,7 @@ acpi/
7272
- info on ACPI-specific hooks in the kernel.
7373
aoe/
7474
- description of AoE (ATA over Ethernet) along with config examples.
75-
applying-patches.txt
75+
process/applying-patches.rst
7676
- description of various trees and how to apply their patches.
7777
arm/
7878
- directory with info about Linux on the ARM architecture.
@@ -86,7 +86,7 @@ auxdisplay/
8686
- misc. LCD driver documentation (cfag12864b, ks0108).
8787
backlight/
8888
- directory with info on controlling backlights in flat panel displays
89-
bad_memory.txt
89+
admin-guide/bad-memory.rst
9090
- how to use kernel parameters to exclude bad RAM regions.
9191
basic_profiling.txt
9292
- basic instructions for those who wants to profile Linux kernel.
@@ -154,7 +154,7 @@ process/
154154
- how to work with the mainline kernel development process.
155155
device-mapper/
156156
- directory with info on Device Mapper.
157-
devices.txt
157+
admin-guide/devices.rst
158158
- plain ASCII listing of all the nodes in /dev/ with major minor #'s.
159159
devicetree/
160160
- directory with info on device tree files used by OF/PowerPC/ARM
@@ -178,7 +178,7 @@ efi-stub.txt
178178
- How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
179179
eisa.txt
180180
- info on EISA bus support.
181-
email-clients.txt
181+
process/email-clients.rst
182182
- info on how to use e-mail to send un-mangled (git) patches.
183183
extcon/
184184
- directory with porting guide for Android kernel switch driver.
@@ -226,9 +226,9 @@ ia64/
226226
- directory with info about Linux on Intel 64 bit architecture.
227227
infiniband/
228228
- directory with documents concerning Linux InfiniBand support.
229-
init.txt
229+
admin-guide/init.rst
230230
- what to do when the kernel can't find the 1st process to run.
231-
initrd.txt
231+
admin-guide/initrd.rst
232232
- how to use the RAM disk as an initial/temporary root filesystem.
233233
input/
234234
- info on Linux input device support.
@@ -248,19 +248,19 @@ isapnp.txt
248248
- info on Linux ISA Plug & Play support.
249249
isdn/
250250
- directory with info on the Linux ISDN support, and supported cards.
251-
java.txt
251+
admin-guide/java.rst
252252
- info on the in-kernel binary support for Java(tm).
253253
ja_JP/
254254
- directory with Japanese translations of various documents
255255
kbuild/
256256
- directory with info about the kernel build process.
257257
kdump/
258258
- directory with mini HowTo on getting the crash dump code to work.
259-
kernel-docs.txt
259+
process/kernel-docs.rst
260260
- listing of various WWW + books that document kernel internals.
261261
kernel-documentation.rst
262262
- how to write and format reStructuredText kernel documentation
263-
kernel-parameters.txt
263+
admin-guide/kernel-parameters.rst
264264
- summary listing of command line / boot prompt args for the kernel.
265265
kernel-per-CPU-kthreads.txt
266266
- List of all per-CPU kthreads and how they introduce jitter.
@@ -302,7 +302,7 @@ magic-number.txt
302302
- list of magic numbers used to mark/protect kernel data structures.
303303
mailbox.txt
304304
- How to write drivers for the common mailbox framework (IPC).
305-
md.txt
305+
admin-guide/md.rst
306306
- info on boot arguments for the multiple devices driver.
307307
media-framework.txt
308308
- info on media framework, its data structures, functions and usage.
@@ -326,7 +326,7 @@ module-signing.txt
326326
- Kernel module signing for increased security when loading modules.
327327
mtd/
328328
- directory with info about memory technology devices (flash)
329-
mono.txt
329+
admin-guide/mono.rst
330330
- how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
331331
namespaces/
332332
- directory with various information about namespaces
@@ -340,7 +340,7 @@ nommu-mmap.txt
340340
- documentation about no-mmu memory mapping support.
341341
numastat.txt
342342
- info on how to read Numa policy hit/miss statistics in sysfs.
343-
oops-tracing.txt
343+
admin-guide/oops-tracing.rst
344344
- how to decode those nasty internal kernel error dump messages.
345345
padata.txt
346346
- An introduction to the "padata" parallel execution API
@@ -378,7 +378,7 @@ ptp/
378378
- directory with info on support for IEEE 1588 PTP clocks in Linux.
379379
pwm.txt
380380
- info on the pulse width modulation driver subsystem
381-
ramoops.txt
381+
admin-guide/ramoops.rst
382382
- documentation of the ramoops oops/panic logging module.
383383
rapidio/
384384
- directory with info on RapidIO packet-based fabric interconnect
@@ -406,7 +406,7 @@ security/
406406
- directory that contains security-related info
407407
serial/
408408
- directory with info on the low level serial API.
409-
serial-console.txt
409+
admin-guide/serial-console.rst
410410
- how to set up Linux with a serial line console as the default.
411411
sgi-ioc4.txt
412412
- description of the SGI IOC4 PCI (multi function) device.
@@ -420,9 +420,9 @@ sparse.txt
420420
- info on how to obtain and use the sparse tool for typechecking.
421421
spi/
422422
- overview of Linux kernel Serial Peripheral Interface (SPI) support.
423-
stable_api_nonsense.txt
423+
process/stable-api-nonsense.rst
424424
- 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
426426
- rules and procedures for the -stable kernel releases.
427427
static-keys.txt
428428
- info on how static keys allow debug code in hotpaths via patching
@@ -444,7 +444,7 @@ trace/
444444
- directory with info on tracing technologies within linux
445445
unaligned-memory-access.txt
446446
- info on how to avoid arch breaking unaligned memory access in code.
447-
unicode.txt
447+
admin-guide/unicode.rst
448448
- info on the Unicode character/font mapping used in Linux.
449449
unshare.txt
450450
- description of the Linux unshare system call.
@@ -466,7 +466,7 @@ vm/
466466
- directory with info on the Linux vm code.
467467
vme_api.txt
468468
- file relating info on the VME bus API in linux
469-
volatile-considered-harmful.txt
469+
process/volatile-considered-harmful.rst
470470
- Why the "volatile" type class should not be used
471471
w1/
472472
- directory with documents regarding the 1-wire (w1) subsystem.

‎Documentation/ABI/README‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,4 @@ stable:
8484

8585
- Kernel-internal symbols. Do not rely on the presence, absence, location, or
8686
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.

‎Documentation/ABI/testing/sysfs-kernel-slab‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ Description:
347347
because of fragmentation, SLUB will retry with the minimum order
348348
possible depending on its characteristics.
349349
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
351351
order is used and this sysfs entry can not be used to change
352352
the order at run time.
353353

‎Documentation/DocBook/kernel-hacking.tmpl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1208,8 +1208,8 @@ static struct block_device_operations opt_fops = {
12081208

12091209
<listitem>
12101210
<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>.
12131213
</para>
12141214
</listitem>
12151215
</itemizedlist>

‎Documentation/acpi/video_extension.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,6 @@ received a notification, it will set the backlight level accordingly. This does
101101
not affect the sending of event to user space, they are always sent to user
102102
space regardless of whether or not the video module controls the backlight level
103103
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
105105
disable this behaviour once a GUI environment starts up and wants to have full
106106
control of the backlight level.

‎Documentation/admin-guide/README.rst‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ Documentation
5050
- There are various README files in the Documentation/ subdirectory:
5151
these typically contain kernel-specific installation notes for some
5252
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
5455
contains information about the problems, which may result by upgrading
5556
your kernel.
5657

@@ -96,7 +97,7 @@ Installing the kernel source
9697
and 4.0.2 patches. Similarly, if you are running kernel version 4.0.2 and
9798
want to jump to 4.0.3, you must first reverse the 4.0.2 patch (that is,
9899
patch -R) **before** applying the 4.0.3 patch. You can read more on this in
99-
:ref:`Documentation/applying-patches.txt <applying_patches>`.
100+
:ref:`Documentation/process/applying-patches.rst <applying_patches>`.
100101

101102
Alternatively, the script patch-kernel can be used to automate this
102103
process. It determines the current kernel version and applies any
@@ -120,7 +121,7 @@ Software requirements
120121

121122
Compiling and running the 4.x kernels requires up-to-date
122123
versions of various software packages. Consult
123-
:ref:`Documentation/Changes <changes>` for the minimum version numbers
124+
:ref:`Documentation/process/changes.rst <changes>` for the minimum version numbers
124125
required and how to get updates for these packages. Beware that using
125126
excessively old versions of these packages can cause indirect
126127
errors that are very difficult to track down, so don't assume that
@@ -254,7 +255,7 @@ Compiling the kernel
254255
--------------------
255256

256257
- Make sure you have at least gcc 3.2 available.
257-
For more information, refer to :ref:`Documentation/Changes <changes>`.
258+
For more information, refer to :ref:`Documentation/process/changes.rst <changes>`.
258259

259260
Please note that you can still run a.out user programs with this kernel.
260261

@@ -355,7 +356,7 @@ If something goes wrong
355356
help debugging the problem. The text above the dump is also
356357
important: it tells something about why the kernel dumped code (in
357358
the above example, it's due to a bad kernel pointer). More information
358-
on making sense of the dump is in Documentation/oops-tracing.txt
359+
on making sense of the dump is in Documentation/admin-guide/oops-tracing.rst
359360

360361
- If you compiled the kernel with CONFIG_KALLSYMS you can send the dump
361362
as is, otherwise you will have to use the ``ksymoops`` program to make
@@ -393,7 +394,7 @@ If something goes wrong
393394

394395
If you for some reason cannot do the above (you have a pre-compiled
395396
kernel image or similar), telling me as much about your setup as
396-
possible will help. Please read the :ref:`REPORTING-BUGS <reportingbugs>`
397+
possible will help. Please read the :ref:`admin-guide/reporting-bugs.rst <reportingbugs>`
397398
document for details.
398399

399400
- Alternatively, you can use gdb on a running kernel. (read-only; i.e. you

‎Documentation/admin-guide/bad-memory.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ memmap is already in the kernel and usable as kernel-parameter at
3333
boot-time. Its syntax is slightly strange and you may need to
3434
calculate the values by yourself!
3535

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)::
3737

3838
memmap=<size>$<address>
3939

‎Documentation/admin-guide/binfmt-misc.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ A few examples (assumed you are in ``/proc/sys/fs/binfmt_misc``):
124124

125125
echo ':DOSWin:M::MZ::/usr/local/bin/wine:' > register
126126

127-
For java support see Documentation/java.txt
127+
For java support see Documentation/admin-guide/java.rst
128128

129129

130130
You can enable/disable binfmt_misc or one binary type by echoing 0 (to disable)
@@ -140,7 +140,7 @@ Hints
140140
-----
141141

142142
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
144144
example.
145145

146146
Your interpreter should NOT look in the PATH for the filename; the kernel

‎Documentation/admin-guide/braille-console.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Linux Braille Console
33

44
To get early boot messages on a braille device (before userspace screen
55
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
77
for braille device
88
(in :menuselection:`Device Drivers --> Accessibility support --> Console on braille device`).
99

@@ -13,7 +13,7 @@ format is::
1313
console=brl,serial_options...
1414

1515
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>`.
1717

1818
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
1919
override the baud rate to 115200, etc.
@@ -31,7 +31,7 @@ parameter.
3131
For simplicity, only one braille console can be enabled, other uses of
3232
``console=brl,...`` will be discarded. Also note that it does not interfere with
3333
the console selection mechanism described in
34-
:ref:`Documentation/serial-console.txt <serial_console>`.
34+
:ref:`Documentation/admin-guide/serial-console.rst <serial_console>`.
3535

3636
For now, only the VisioBraille device is supported.
3737

‎Documentation/admin-guide/bug-hunting.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ give up. Report as much as you have found to the relevant maintainer. See
1515
MAINTAINERS for who that is for the subsystem you have worked on.
1616

1717
Before you submit a bug report read
18-
:ref:`Documentation/REPORTING-BUGS <reportingbugs>`.
18+
:ref:`Documentation/admin-guide/reporting-bugs.rst <reportingbugs>`.
1919

2020
Devices not appearing
2121
=====================
@@ -244,5 +244,6 @@ Once you have worked out a fix please submit it upstream. After all open
244244
source is about sharing what you do and don't you want to be recognised for
245245
your genius?
246246

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.

0 commit comments

Comments
 (0)