Skip to content

Commit 257e652

Browse files
author
Jonathan Corbet
committed
Merge branch 'mauro' into docs-next
Mauro says: > As discussed at: > https://lore.kernel.org/linux-doc/[email protected]/ > > It is better to avoid using :doc:`foo` to refer to Documentation/foo.rst, as the > automarkup.py extension should handle it automatically, on most cases. > > There are a couple of exceptions to this rule: > > 1. when :doc: tag is used to point to a kernel-doc DOC: markup; > 2. when it is used with a named tag, e. g. :doc:`some name <foo>`; > > On this series: > > Patch 1 manually adjust the references inside driver-api/pm/devices.rst, > as there it uses :file:`foo` to refer to some Documentation/ files; > > Patch 2 converts a table at Documentation/dev-tools/kunit/api/index.rst > into a list, carefully avoiding the > > The remaining patches convert the other occurrences via a replace script. > They were manually edited, in order to honour 80-columns where possible. > > This series based on docs-next branch. In order to avoid merge conflicts, > I rebased it internally against yesterday's linux-next, dropping a patch > and a hunk that would have caused conflicts there. >
2 parents a557f67 + 0ffd643 commit 257e652

Some content is hidden

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

46 files changed

+172
-148
lines changed

Documentation/PCI/endpoint/pci-endpoint-cfs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,4 +125,4 @@ all the EPF devices are created and linked with the EPC device.
125125
| interrupt_pin
126126
| function
127127

128-
[1] :doc:`pci-endpoint`
128+
[1] Documentation/PCI/endpoint/pci-endpoint.rst

Documentation/PCI/pci.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ Set the DMA mask size
265265
---------------------
266266
.. note::
267267
If anything below doesn't make sense, please refer to
268-
:doc:`/core-api/dma-api`. This section is just a reminder that
268+
Documentation/core-api/dma-api.rst. This section is just a reminder that
269269
drivers need to indicate DMA capabilities of the device and is not
270270
an authoritative source for DMA interfaces.
271271

@@ -291,7 +291,7 @@ Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are
291291
Setup shared control data
292292
-------------------------
293293
Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared)
294-
memory. See :doc:`/core-api/dma-api` for a full description of
294+
memory. See Documentation/core-api/dma-api.rst for a full description of
295295
the DMA APIs. This section is just a reminder that it needs to be done
296296
before enabling DMA on the device.
297297

@@ -421,7 +421,7 @@ owners if there is one.
421421

422422
Then clean up "consistent" buffers which contain the control data.
423423

424-
See :doc:`/core-api/dma-api` for details on unmapping interfaces.
424+
See Documentation/core-api/dma-api.rst for details on unmapping interfaces.
425425

426426

427427
Unregister from other subsystems

Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
SRBDS - Special Register Buffer Data Sampling
44
=============================================
55

6-
SRBDS is a hardware vulnerability that allows MDS :doc:`mds` techniques to
6+
SRBDS is a hardware vulnerability that allows MDS
7+
Documentation/admin-guide/hw-vuln/mds.rst techniques to
78
infer values returned from special register accesses. Special register
89
accesses are accesses to off core registers. According to Intel's evaluation,
910
the special register reads that have a security expectation of privacy are

Documentation/admin-guide/pm/intel_idle.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Nehalem and later generations of Intel processors, but the level of support for
2020
a particular processor model in it depends on whether or not it recognizes that
2121
processor model and may also depend on information coming from the platform
2222
firmware. [To understand ``intel_idle`` it is necessary to know how ``CPUIdle``
23-
works in general, so this is the time to get familiar with :doc:`cpuidle` if you
24-
have not done that yet.]
23+
works in general, so this is the time to get familiar with
24+
Documentation/admin-guide/pm/cpuidle.rst if you have not done that yet.]
2525

2626
``intel_idle`` uses the ``MWAIT`` instruction to inform the processor that the
2727
logical CPU executing it is idle and so it may be possible to put some of the
@@ -53,7 +53,8 @@ processor) corresponding to them depends on the processor model and it may also
5353
depend on the configuration of the platform.
5454

5555
In order to create a list of available idle states required by the ``CPUIdle``
56-
subsystem (see :ref:`idle-states-representation` in :doc:`cpuidle`),
56+
subsystem (see :ref:`idle-states-representation` in
57+
Documentation/admin-guide/pm/cpuidle.rst),
5758
``intel_idle`` can use two sources of information: static tables of idle states
5859
for different processor models included in the driver itself and the ACPI tables
5960
of the system. The former are always used if the processor model at hand is
@@ -98,7 +99,8 @@ states may not be enabled by default if there are no matching entries in the
9899
preliminary list of idle states coming from the ACPI tables. In that case user
99100
space still can enable them later (on a per-CPU basis) with the help of
100101
the ``disable`` idle state attribute in ``sysfs`` (see
101-
:ref:`idle-states-representation` in :doc:`cpuidle`). This basically means that
102+
:ref:`idle-states-representation` in
103+
Documentation/admin-guide/pm/cpuidle.rst). This basically means that
102104
the idle states "known" to the driver may not be enabled by default if they have
103105
not been exposed by the platform firmware (through the ACPI tables).
104106

@@ -186,7 +188,8 @@ be desirable. In practice, it is only really necessary to do that if the idle
186188
states in question cannot be enabled during system startup, because in the
187189
working state of the system the CPU power management quality of service (PM
188190
QoS) feature can be used to prevent ``CPUIdle`` from touching those idle states
189-
even if they have been enumerated (see :ref:`cpu-pm-qos` in :doc:`cpuidle`).
191+
even if they have been enumerated (see :ref:`cpu-pm-qos` in
192+
Documentation/admin-guide/pm/cpuidle.rst).
190193
Setting ``max_cstate`` to 0 causes the ``intel_idle`` initialization to fail.
191194

192195
The ``no_acpi`` and ``use_acpi`` module parameters (recognized by ``intel_idle``
@@ -202,7 +205,8 @@ Namely, the positions of the bits that are set in the ``states_off`` value are
202205
the indices of idle states to be disabled by default (as reflected by the names
203206
of the corresponding idle state directories in ``sysfs``, :file:`state0`,
204207
:file:`state1` ... :file:`state<i>` ..., where ``<i>`` is the index of the given
205-
idle state; see :ref:`idle-states-representation` in :doc:`cpuidle`).
208+
idle state; see :ref:`idle-states-representation` in
209+
Documentation/admin-guide/pm/cpuidle.rst).
206210

207211
For example, if ``states_off`` is equal to 3, the driver will disable idle
208212
states 0 and 1 by default, and if it is equal to 8, idle state 3 will be

Documentation/admin-guide/pm/intel_pstate.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ General Information
1818
(``CPUFreq``). It is a scaling driver for the Sandy Bridge and later
1919
generations of Intel processors. Note, however, that some of those processors
2020
may not be supported. [To understand ``intel_pstate`` it is necessary to know
21-
how ``CPUFreq`` works in general, so this is the time to read :doc:`cpufreq` if
22-
you have not done that yet.]
21+
how ``CPUFreq`` works in general, so this is the time to read
22+
Documentation/admin-guide/pm/cpufreq.rst if you have not done that yet.]
2323

2424
For the processors supported by ``intel_pstate``, the P-state concept is broader
2525
than just an operating frequency or an operating performance point (see the
@@ -445,8 +445,9 @@ Interpretation of Policy Attributes
445445
-----------------------------------
446446

447447
The interpretation of some ``CPUFreq`` policy attributes described in
448-
:doc:`cpufreq` is special with ``intel_pstate`` as the current scaling driver
449-
and it generally depends on the driver's `operation mode <Operation Modes_>`_.
448+
Documentation/admin-guide/pm/cpufreq.rst is special with ``intel_pstate``
449+
as the current scaling driver and it generally depends on the driver's
450+
`operation mode <Operation Modes_>`_.
450451

451452
First of all, the values of the ``cpuinfo_max_freq``, ``cpuinfo_min_freq`` and
452453
``scaling_cur_freq`` attributes are produced by applying a processor-specific

Documentation/admin-guide/sysctl/abi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Documentation for /proc/sys/abi/
1111
1212
Copyright (c) 2020, Stephen Kitt
1313

14-
For general info, see :doc:`index`.
14+
For general info, see Documentation/admin-guide/sysctl/index.rst.
1515

1616
------------------------------------------------------------------------------
1717

Documentation/admin-guide/sysctl/kernel.rst

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ Copyright (c) 1998, 1999, Rik van Riel <[email protected]>
99

1010
Copyright (c) 2009, Shen Feng<[email protected]>
1111

12-
For general info and legal blurb, please look in :doc:`index`.
12+
For general info and legal blurb, please look in
13+
Documentation/admin-guide/sysctl/index.rst.
1314

1415
------------------------------------------------------------------------------
1516

@@ -54,7 +55,7 @@ free space valid for 30 seconds.
5455
acpi_video_flags
5556
================
5657

57-
See :doc:`/power/video`. This allows the video resume mode to be set,
58+
See Documentation/power/video.rst. This allows the video resume mode to be set,
5859
in a similar fashion to the ``acpi_sleep`` kernel parameter, by
5960
combining the following values:
6061

@@ -89,7 +90,7 @@ is 0x15 and the full version number is 0x234, this file will contain
8990
the value 340 = 0x154.
9091

9192
See the ``type_of_loader`` and ``ext_loader_type`` fields in
92-
:doc:`/x86/boot` for additional information.
93+
Documentation/x86/boot.rst for additional information.
9394

9495

9596
bootloader_version (x86 only)
@@ -99,7 +100,7 @@ The complete bootloader version number. In the example above, this
99100
file will contain the value 564 = 0x234.
100101

101102
See the ``type_of_loader`` and ``ext_loader_ver`` fields in
102-
:doc:`/x86/boot` for additional information.
103+
Documentation/x86/boot.rst for additional information.
103104

104105

105106
bpf_stats_enabled
@@ -269,7 +270,7 @@ see the ``hostname(1)`` man page.
269270
firmware_config
270271
===============
271272

272-
See :doc:`/driver-api/firmware/fallback-mechanisms`.
273+
See Documentation/driver-api/firmware/fallback-mechanisms.rst.
273274

274275
The entries in this directory allow the firmware loader helper
275276
fallback to be controlled:
@@ -297,7 +298,7 @@ crashes and outputting them to a serial console.
297298
ftrace_enabled, stack_tracer_enabled
298299
====================================
299300

300-
See :doc:`/trace/ftrace`.
301+
See Documentation/trace/ftrace.rst.
301302

302303

303304
hardlockup_all_cpu_backtrace
@@ -325,7 +326,7 @@ when a hard lockup is detected.
325326
1 Panic on hard lockup.
326327
= ===========================
327328

328-
See :doc:`/admin-guide/lockup-watchdogs` for more information.
329+
See Documentation/admin-guide/lockup-watchdogs.rst for more information.
329330
This can also be set using the nmi_watchdog kernel parameter.
330331

331332

@@ -586,7 +587,8 @@ in a KVM virtual machine. This default can be overridden by adding::
586587

587588
nmi_watchdog=1
588589

589-
to the guest kernel command line (see :doc:`/admin-guide/kernel-parameters`).
590+
to the guest kernel command line (see
591+
Documentation/admin-guide/kernel-parameters.rst).
590592

591593

592594
numa_balancing
@@ -1071,7 +1073,7 @@ that support this feature.
10711073
real-root-dev
10721074
=============
10731075

1074-
See :doc:`/admin-guide/initrd`.
1076+
See Documentation/admin-guide/initrd.rst.
10751077

10761078

10771079
reboot-cmd (SPARC only)
@@ -1158,7 +1160,7 @@ will take effect.
11581160
seccomp
11591161
=======
11601162

1161-
See :doc:`/userspace-api/seccomp_filter`.
1163+
See Documentation/userspace-api/seccomp_filter.rst.
11621164

11631165

11641166
sg-big-buff
@@ -1329,7 +1331,7 @@ the boot PROM.
13291331
sysrq
13301332
=====
13311333

1332-
See :doc:`/admin-guide/sysrq`.
1334+
See Documentation/admin-guide/sysrq.rst.
13331335

13341336

13351337
tainted
@@ -1359,15 +1361,16 @@ ORed together. The letters are seen in "Tainted" line of Oops reports.
13591361
131072 `(T)` The kernel was built with the struct randomization plugin
13601362
====== ===== ==============================================================
13611363

1362-
See :doc:`/admin-guide/tainted-kernels` for more information.
1364+
See Documentation/admin-guide/tainted-kernels.rst for more information.
13631365

13641366
Note:
13651367
writes to this sysctl interface will fail with ``EINVAL`` if the kernel is
13661368
booted with the command line option ``panic_on_taint=<bitmask>,nousertaint``
13671369
and any of the ORed together values being written to ``tainted`` match with
13681370
the bitmask declared on panic_on_taint.
1369-
See :doc:`/admin-guide/kernel-parameters` for more details on that particular
1370-
kernel command line option and its optional ``nousertaint`` switch.
1371+
See Documentation/admin-guide/kernel-parameters.rst for more details on
1372+
that particular kernel command line option and its optional
1373+
``nousertaint`` switch.
13711374

13721375
threads-max
13731376
===========
@@ -1391,7 +1394,7 @@ If a value outside of this range is written to ``threads-max`` an
13911394
traceoff_on_warning
13921395
===================
13931396

1394-
When set, disables tracing (see :doc:`/trace/ftrace`) when a
1397+
When set, disables tracing (see Documentation/trace/ftrace.rst) when a
13951398
``WARN()`` is hit.
13961399

13971400

@@ -1411,8 +1414,8 @@ will send them to printk() again.
14111414

14121415
This only works if the kernel was booted with ``tp_printk`` enabled.
14131416

1414-
See :doc:`/admin-guide/kernel-parameters` and
1415-
:doc:`/trace/boottime-trace`.
1417+
See Documentation/admin-guide/kernel-parameters.rst and
1418+
Documentation/trace/boottime-trace.rst.
14161419

14171420

14181421
.. _unaligned-dump-stack:

Documentation/block/biodoc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ a virtual address mapping (unlike the earlier scheme of virtual address
196196
do not have a corresponding kernel virtual address space mapping) and
197197
low-memory pages.
198198

199-
Note: Please refer to :doc:`/core-api/dma-api-howto` for a discussion
199+
Note: Please refer to Documentation/core-api/dma-api-howto.rst for a discussion
200200
on PCI high mem DMA aspects and mapping of scatter gather lists, and support
201201
for 64 bit PCI.
202202

Documentation/bpf/bpf_lsm.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ LSM hook:
2020
Other LSM hooks which can be instrumented can be found in
2121
``include/linux/lsm_hooks.h``.
2222
23-
eBPF programs that use :doc:`/bpf/btf` do not need to include kernel headers
24-
for accessing information from the attached eBPF program's context. They can
25-
simply declare the structures in the eBPF program and only specify the fields
26-
that need to be accessed.
23+
eBPF programs that use Documentation/bpf/btf.rst do not need to include kernel
24+
headers for accessing information from the attached eBPF program's context.
25+
They can simply declare the structures in the eBPF program and only specify
26+
the fields that need to be accessed.
2727
2828
.. code-block:: c
2929
@@ -88,8 +88,9 @@ example:
8888
8989
The ``__attribute__((preserve_access_index))`` is a clang feature that allows
9090
the BPF verifier to update the offsets for the access at runtime using the
91-
:doc:`/bpf/btf` information. Since the BPF verifier is aware of the types, it
92-
also validates all the accesses made to the various types in the eBPF program.
91+
Documentation/bpf/btf.rst information. Since the BPF verifier is aware of the
92+
types, it also validates all the accesses made to the various types in the
93+
eBPF program.
9394

9495
Loading
9596
-------

Documentation/core-api/bus-virt-phys-mapping.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ How to access I/O mapped memory from within device drivers
88

99
The virt_to_bus() and bus_to_virt() functions have been
1010
superseded by the functionality provided by the PCI DMA interface
11-
(see :doc:`/core-api/dma-api-howto`). They continue
11+
(see Documentation/core-api/dma-api-howto.rst). They continue
1212
to be documented below for historical purposes, but new code
1313
must not use them. --davidm 00/12/12
1414

0 commit comments

Comments
 (0)