On 05/01/2024 21:07, Mauro Carvalho Chehab wrote:
Em Thu, 4 Jan 2024 17:09:45 +0100
Vegard Nossum <vegard.nossum@xxxxxxxxxx> escreveu:
+Every file in these directories will contain the following information::
+
+ What: Short description of the interface
+ Date: Date created
+ KernelVersion: Kernel version this feature first showed up in.
+ Contact: Primary contact for this interface (may be a mailing list)
+ Description: Long description of the interface and how to use it.
+ Users: All users of this interface who wish to be notified when
+ it changes. This is very important for interfaces in
+ the "testing" stage, so that kernel developers can work
+ with userspace developers to ensure that things do not
+ break in ways that are unacceptable. It is also
+ important to get feedback for these interfaces to make
+ sure they are working in a proper way and do not need to
+ be changed further.
My personal preference would be to use:
:What:
as this produces a better markup.
I would prefer to alter this as little as possible, since it describes
the literal format of those ABI files, keeping it readable and
understandable in plain text as well as HTML -- with a single leading
space this whole block shows up as a code block in the HTML, which I
think is appropriate when giving an example of a literal file.
diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rst
index b1bc2d37bd0a..7e6198ab368d 100644
--- a/Documentation/process/submit-checklist.rst
+++ b/Documentation/process/submit-checklist.rst
@@ -85,7 +85,7 @@ and elsewhere regarding submitting Linux kernel patches.
17) All new module parameters are documented with ``MODULE_PARM_DESC()``
18) All new userspace interfaces are documented in ``Documentation/ABI/``.
- See ``Documentation/ABI/README`` for more information.
+ See ``Documentation/ABI/README.rst`` for more information.
If you're willing to convert to ReST, please remove ``, as this will
let automarkup.py to create cross-reference links. Same note for the
translations too.
Good point -- Jon, do you want me to resubmit this or can you fix it up?
We could also just run a "treewide" fix for this as a separate patch:
git grep -l '``Documentation/.*\.rst``' 'Documentation/**.rst' \
| xargs sed -i 's|``\(Documentation[^`*]*\.rst\)``|\1|g'
I've attached the result (with 1 exclusion, see the changelog) as a patch.
Thanks,
VegardFrom 262186f2bc7ca72dbb8b68e282d3e418918fe6d8 Mon Sep 17 00:00:00 2001
From: Vegard Nossum <vegard.nossum@xxxxxxxxxx>
Date: Mon, 8 Jan 2024 14:11:02 +0100
Subject: [PATCH] docs: rely on automarkup for Documentation/**.rst links
If we remove ``...`` around Documentation/ links to .rst files in .rst
files, then automarkup.py can create cross-reference links and warn about
non-existent files.
git grep -l '``Documentation/.*\.rst``' 'Documentation/**.rst' \
| xargs sed -i 's|``\(Documentation[^`*]*\.rst\)``|\1|g'
I've excluded one instance in Documentation/doc-guide/sphinx.rst to the
top-level Documentation/index.rst file as I believe it makes more sense
to keep that as a literal path.
Link: https://lore.kernel.org/all/20240105210739.20ae5f05@xxxxxxxx/
Suggested-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx>
Signed-off-by: Vegard Nossum <vegard.nossum@xxxxxxxxxx>
---
Documentation/admin-guide/mm/numa_memory_policy.rst | 2 +-
Documentation/admin-guide/serial-console.rst | 2 +-
Documentation/driver-api/dmaengine/client.rst | 2 +-
Documentation/driver-api/nvdimm/security.rst | 2 +-
Documentation/filesystems/fscrypt.rst | 4 ++--
Documentation/kernel-hacking/hacking.rst | 6 +++---
Documentation/kernel-hacking/locking.rst | 2 +-
Documentation/networking/dsa/b53.rst | 2 +-
Documentation/networking/dsa/bcm_sf2.rst | 2 +-
Documentation/networking/dsa/dsa.rst | 2 +-
Documentation/networking/dsa/lan9303.rst | 2 +-
Documentation/process/adding-syscalls.rst | 2 +-
Documentation/process/submit-checklist.rst | 8 ++++----
Documentation/security/keys/trusted-encrypted.rst | 4 ++--
Documentation/sound/kernel-api/writing-an-alsa-driver.rst | 2 +-
Documentation/translations/it_IT/doc-guide/sphinx.rst | 2 +-
.../translations/it_IT/kernel-hacking/hacking.rst | 6 +++---
.../translations/it_IT/kernel-hacking/locking.rst | 2 +-
.../translations/it_IT/process/adding-syscalls.rst | 2 +-
.../translations/it_IT/process/submit-checklist.rst | 8 ++++----
.../translations/sp_SP/process/adding-syscalls.rst | 2 +-
.../translations/sp_SP/process/submit-checklist.rst | 8 ++++----
Documentation/translations/zh_CN/doc-guide/sphinx.rst | 2 +-
.../translations/zh_CN/process/submit-checklist.rst | 6 +++---
.../translations/zh_TW/process/submit-checklist.rst | 6 +++---
Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst | 2 +-
Documentation/userspace-api/media/v4l/diff-v4l.rst | 2 +-
Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst | 2 +-
Documentation/virt/uml/user_mode_linux_howto_v2.rst | 2 +-
29 files changed, 48 insertions(+), 48 deletions(-)
diff --git a/Documentation/admin-guide/mm/numa_memory_policy.rst b/Documentation/admin-guide/mm/numa_memory_policy.rst
index eca38fa81e0f..7d43b8042a05 100644
--- a/Documentation/admin-guide/mm/numa_memory_policy.rst
+++ b/Documentation/admin-guide/mm/numa_memory_policy.rst
@@ -13,7 +13,7 @@ document attempts to describe the concepts and APIs of the 2.6 memory policy
support.
Memory policies should not be confused with cpusets
-(``Documentation/admin-guide/cgroup-v1/cpusets.rst``)
+(Documentation/admin-guide/cgroup-v1/cpusets.rst)
which is an administrative mechanism for restricting the nodes from which
memory may be allocated by a set of processes. Memory policies are a
programming interface that a NUMA-aware application can take advantage of. When
diff --git a/Documentation/admin-guide/serial-console.rst b/Documentation/admin-guide/serial-console.rst
index a3dfc2c66e01..0befd17f66b6 100644
--- a/Documentation/admin-guide/serial-console.rst
+++ b/Documentation/admin-guide/serial-console.rst
@@ -84,7 +84,7 @@ You will need to create a new device to use ``/dev/console``. The official
``/dev/console`` is now character device 5,1.
(You can also use a network device as a console. See
-``Documentation/networking/netconsole.rst`` for information on that.)
+Documentation/networking/netconsole.rst for information on that.)
Here's an example that will use ``/dev/ttyS1`` (COM2) as the console.
Replace the sample values as needed.
diff --git a/Documentation/driver-api/dmaengine/client.rst b/Documentation/driver-api/dmaengine/client.rst
index ecf139f73da4..bf1346792855 100644
--- a/Documentation/driver-api/dmaengine/client.rst
+++ b/Documentation/driver-api/dmaengine/client.rst
@@ -5,7 +5,7 @@ DMA Engine API Guide
Vinod Koul <vinod dot koul at intel.com>
.. note:: For DMA Engine usage in async_tx please see:
- ``Documentation/crypto/async-tx-api.rst``
+ Documentation/crypto/async-tx-api.rst
Below is a guide to device driver writers on how to use the Slave-DMA API of the
diff --git a/Documentation/driver-api/nvdimm/security.rst b/Documentation/driver-api/nvdimm/security.rst
index eb3d35e6a95c..6deb677dea3b 100644
--- a/Documentation/driver-api/nvdimm/security.rst
+++ b/Documentation/driver-api/nvdimm/security.rst
@@ -51,7 +51,7 @@ all the keys are in the kernel user keyring for unlock.
A nvdimm encrypted-key of format enc32 has the description format of:
nvdimm:<bus-provider-specific-unique-id>
-See file ``Documentation/security/keys/trusted-encrypted.rst`` for creating
+See file Documentation/security/keys/trusted-encrypted.rst for creating
encrypted-keys of enc32 format. TPM usage with a master trusted key is
preferred for sealing the encrypted-keys.
diff --git a/Documentation/filesystems/fscrypt.rst b/Documentation/filesystems/fscrypt.rst
index 1b84f818e574..d6a93e47e70c 100644
--- a/Documentation/filesystems/fscrypt.rst
+++ b/Documentation/filesystems/fscrypt.rst
@@ -874,7 +874,7 @@ as follows:
hash of the key. To add this type of key, the calling process does
not need any privileges. However, the number of keys that can be
added is limited by the user's quota for the keyrings service (see
- ``Documentation/security/keys/core.rst``).
+ Documentation/security/keys/core.rst).
- ``raw_size`` must be the size of the ``raw`` key provided, in bytes.
Alternatively, if ``key_id`` is nonzero, this field must be 0, since
@@ -956,7 +956,7 @@ access encrypted files.
Nevertheless, to add a key to one of the process-subscribed keyrings,
the add_key() system call can be used (see:
-``Documentation/security/keys/core.rst``). The key type must be
+Documentation/security/keys/core.rst). The key type must be
"logon"; keys of this type are kept in kernel memory and cannot be
read back by userspace. The key description must be "fscrypt:"
followed by the 16-character lower case hex representation of the
diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
index 1717348a4404..05338ef0912f 100644
--- a/Documentation/kernel-hacking/hacking.rst
+++ b/Documentation/kernel-hacking/hacking.rst
@@ -736,7 +736,7 @@ make a neat patch, there's administrative work to be done:
- Usually you want a configuration option for your kernel hack. Edit
``Kconfig`` in the appropriate directory. The Config language is
simple to use by cut and paste, and there's complete documentation in
- ``Documentation/kbuild/kconfig-language.rst``.
+ Documentation/kbuild/kconfig-language.rst.
In your description of the option, make sure you address both the
expert user and the user who knows nothing about your feature.
@@ -746,7 +746,7 @@ make a neat patch, there's administrative work to be done:
- Edit the ``Makefile``: the CONFIG variables are exported here so you
can usually just add a "obj-$(CONFIG_xxx) += xxx.o" line. The syntax
- is documented in ``Documentation/kbuild/makefiles.rst``.
+ is documented in Documentation/kbuild/makefiles.rst.
- Put yourself in ``CREDITS`` if you consider what you've done
noteworthy, usually beyond a single file (your name should be at the
@@ -755,7 +755,7 @@ make a neat patch, there's administrative work to be done:
it implies a more-than-passing commitment to some part of the code.
- Finally, don't forget to read
- ``Documentation/process/submitting-patches.rst``
+ Documentation/process/submitting-patches.rst
Kernel Cantrips
===============
diff --git a/Documentation/kernel-hacking/locking.rst b/Documentation/kernel-hacking/locking.rst
index dff0646a717b..d479c2459895 100644
--- a/Documentation/kernel-hacking/locking.rst
+++ b/Documentation/kernel-hacking/locking.rst
@@ -1370,7 +1370,7 @@ Futex API reference
Further reading
===============
-- ``Documentation/locking/spinlocks.rst``: Linus Torvalds' spinlocking
+- Documentation/locking/spinlocks.rst: Linus Torvalds' spinlocking
tutorial in the kernel sources.
- Unix Systems for Modern Architectures: Symmetric Multiprocessing and
diff --git a/Documentation/networking/dsa/b53.rst b/Documentation/networking/dsa/b53.rst
index 1cb3ff648f88..51fd39ca5201 100644
--- a/Documentation/networking/dsa/b53.rst
+++ b/Documentation/networking/dsa/b53.rst
@@ -14,7 +14,7 @@ Implementation details
======================
The driver is located in ``drivers/net/dsa/b53/`` and is implemented as a
-DSA driver; see ``Documentation/networking/dsa/dsa.rst`` for details on the
+DSA driver; see Documentation/networking/dsa/dsa.rst for details on the
subsystem and what it provides.
The switch is, if possible, configured to enable a Broadcom specific 4-bytes
diff --git a/Documentation/networking/dsa/bcm_sf2.rst b/Documentation/networking/dsa/bcm_sf2.rst
index d2571435696f..ba7371aad142 100644
--- a/Documentation/networking/dsa/bcm_sf2.rst
+++ b/Documentation/networking/dsa/bcm_sf2.rst
@@ -39,7 +39,7 @@ Implementation details
======================
The driver is located in ``drivers/net/dsa/bcm_sf2.c`` and is implemented as a DSA
-driver; see ``Documentation/networking/dsa/dsa.rst`` for details on the subsystem
+driver; see Documentation/networking/dsa/dsa.rst for details on the subsystem
and what it provides.
The SF2 switch is configured to enable a Broadcom specific 4-bytes switch tag
diff --git a/Documentation/networking/dsa/dsa.rst b/Documentation/networking/dsa/dsa.rst
index 7b2e69cd7ef0..6e185a08396b 100644
--- a/Documentation/networking/dsa/dsa.rst
+++ b/Documentation/networking/dsa/dsa.rst
@@ -1110,7 +1110,7 @@ interface with a physical switch port does not produce the expected result).
A driver which is able of offloading certain functions of a DANP or DANH should
declare the corresponding netdev features as indicated by the documentation at
-``Documentation/networking/netdev-features.rst``. Additionally, the following
+Documentation/networking/netdev-features.rst. Additionally, the following
methods must be implemented:
- ``port_hsr_join``: function invoked when a given switch port is added to a
diff --git a/Documentation/networking/dsa/lan9303.rst b/Documentation/networking/dsa/lan9303.rst
index ab81b4e0139e..97456316a8d9 100644
--- a/Documentation/networking/dsa/lan9303.rst
+++ b/Documentation/networking/dsa/lan9303.rst
@@ -10,7 +10,7 @@ host conduit network interface (e.g. fixed link).
Driver details
==============
-The driver is implemented as a DSA driver, see ``Documentation/networking/dsa/dsa.rst``.
+The driver is implemented as a DSA driver, see Documentation/networking/dsa/dsa.rst.
See ``Documentation/devicetree/bindings/net/dsa/lan9303.txt`` for device tree
binding.
diff --git a/Documentation/process/adding-syscalls.rst b/Documentation/process/adding-syscalls.rst
index 906c47f1a9e5..5e6d26ef31eb 100644
--- a/Documentation/process/adding-syscalls.rst
+++ b/Documentation/process/adding-syscalls.rst
@@ -33,7 +33,7 @@ interface.
to a somewhat opaque API.
- If you're just exposing runtime system information, a new node in sysfs
- (see ``Documentation/filesystems/sysfs.rst``) or the ``/proc`` filesystem may
+ (see Documentation/filesystems/sysfs.rst) or the ``/proc`` filesystem may
be more appropriate. However, access to these mechanisms requires that the
relevant filesystem is mounted, which might not always be the case (e.g.
in a namespaced/sandboxed/chrooted environment). Avoid adding any API to
diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rst
index 7e6198ab368d..4c25fa07d1d5 100644
--- a/Documentation/process/submit-checklist.rst
+++ b/Documentation/process/submit-checklist.rst
@@ -43,7 +43,7 @@ and elsewhere regarding submitting Linux kernel patches.
6) Any new or modified ``CONFIG`` options do not muck up the config menu and
default to off unless they meet the exception criteria documented in
- ``Documentation/kbuild/kconfig-language.rst`` Menu attributes: default value.
+ Documentation/kbuild/kconfig-language.rst Menu attributes: default value.
7) All new ``Kconfig`` options have help text.
@@ -80,12 +80,12 @@ and elsewhere regarding submitting Linux kernel patches.
15) All new ``/proc`` entries are documented under ``Documentation/``
16) All new kernel boot parameters are documented in
- ``Documentation/admin-guide/kernel-parameters.rst``.
+ Documentation/admin-guide/kernel-parameters.rst.
17) All new module parameters are documented with ``MODULE_PARM_DESC()``
18) All new userspace interfaces are documented in ``Documentation/ABI/``.
- See ``Documentation/ABI/README.rst`` for more information.
+ See Documentation/ABI/README.rst for more information.
Patches that change userspace interfaces should be CCed to
linux-api@xxxxxxxxxxxxxxx.
@@ -108,7 +108,7 @@ and elsewhere regarding submitting Linux kernel patches.
and why.
23) If any ioctl's are added by the patch, then also update
- ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
+ Documentation/userspace-api/ioctl/ioctl-number.rst.
24) If your modified source code depends on or uses any of the kernel
APIs or features that are related to the following ``Kconfig`` symbols,
diff --git a/Documentation/security/keys/trusted-encrypted.rst b/Documentation/security/keys/trusted-encrypted.rst
index e989b9802f92..7ea1dc3956da 100644
--- a/Documentation/security/keys/trusted-encrypted.rst
+++ b/Documentation/security/keys/trusted-encrypted.rst
@@ -88,7 +88,7 @@ safe.
(2) TEE
TEEs have well-documented, standardized client interface and APIs. For
- more details refer to ``Documentation/driver-api/tee.rst``.
+ more details refer to Documentation/driver-api/tee.rst.
(3) CAAM
@@ -363,7 +363,7 @@ Other uses for trusted and encrypted keys, such as for disk and file encryption
are anticipated. In particular the new format 'ecryptfs' has been defined
in order to use encrypted keys to mount an eCryptfs filesystem. More details
about the usage can be found in the file
-``Documentation/security/keys/ecryptfs.rst``.
+Documentation/security/keys/ecryptfs.rst.
Another new format 'enc32' has been defined in order to support encrypted keys
with payload size of 32 bytes. This will initially be used for nvdimm security
diff --git a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst
index cd421856409e..cf64e1c10ce8 100644
--- a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst
+++ b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst
@@ -2466,7 +2466,7 @@ Mic boost
Mic-boost switch is set as “Mic Boost” or “Mic Boost (6dB)”.
More precise information can be found in
-``Documentation/sound/designs/control-names.rst``.
+Documentation/sound/designs/control-names.rst.
Access Flags
------------
diff --git a/Documentation/translations/it_IT/doc-guide/sphinx.rst b/Documentation/translations/it_IT/doc-guide/sphinx.rst
index 1f513bc33618..f5b2140921a8 100644
--- a/Documentation/translations/it_IT/doc-guide/sphinx.rst
+++ b/Documentation/translations/it_IT/doc-guide/sphinx.rst
@@ -184,7 +184,7 @@ Aggiungere nuova documentazione è semplice:
1. aggiungete un file ``.rst`` nella sottocartella ``Documentation``
2. aggiungete un riferimento ad esso nell'indice (`TOC tree`_) in
- ``Documentation/index.rst``.
+ Documentation/index.rst.
.. _TOC tree: http://www.sphinx-doc.org/en/stable/markup/toctree.html
diff --git a/Documentation/translations/it_IT/kernel-hacking/hacking.rst b/Documentation/translations/it_IT/kernel-hacking/hacking.rst
index dd06bfc1a050..2b8ecc4b2098 100644
--- a/Documentation/translations/it_IT/kernel-hacking/hacking.rst
+++ b/Documentation/translations/it_IT/kernel-hacking/hacking.rst
@@ -771,7 +771,7 @@ anche per avere patch pulite, c'è del lavoro amministrativo da fare:
- Solitamente vorrete un'opzione di configurazione per la vostra modifica
al kernel. Modificate ``Kconfig`` nella cartella giusta. Il linguaggio
Config è facile con copia ed incolla, e c'è una completa documentazione
- nel file ``Documentation/kbuild/kconfig-language.rst``.
+ nel file Documentation/kbuild/kconfig-language.rst.
Nella descrizione della vostra opzione, assicuratevi di parlare sia agli
utenti esperti sia agli utente che non sanno nulla del vostro lavoro.
@@ -783,7 +783,7 @@ anche per avere patch pulite, c'è del lavoro amministrativo da fare:
- Modificate il file ``Makefile``: le variabili CONFIG sono esportate qui,
quindi potete solitamente aggiungere una riga come la seguete
"obj-$(CONFIG_xxx) += xxx.o". La sintassi è documentata nel file
- ``Documentation/kbuild/makefiles.rst``.
+ Documentation/kbuild/makefiles.rst.
- Aggiungete voi stessi in ``CREDITS`` se credete di aver fatto qualcosa di
notevole, solitamente qualcosa che supera il singolo file (comunque il vostro
@@ -793,7 +793,7 @@ anche per avere patch pulite, c'è del lavoro amministrativo da fare:
semplice impegno su una parte del codice.
- Infine, non dimenticatevi di leggere
- ``Documentation/process/submitting-patches.rst``.
+ Documentation/process/submitting-patches.rst.
Trucchetti del kernel
=====================
diff --git a/Documentation/translations/it_IT/kernel-hacking/locking.rst b/Documentation/translations/it_IT/kernel-hacking/locking.rst
index 4c21cf60f775..ab0fa1826f95 100644
--- a/Documentation/translations/it_IT/kernel-hacking/locking.rst
+++ b/Documentation/translations/it_IT/kernel-hacking/locking.rst
@@ -1409,7 +1409,7 @@ Riferimento per l'API dei Futex
Approfondimenti
===============
-- ``Documentation/locking/spinlocks.rst``: la guida di Linus Torvalds agli
+- Documentation/locking/spinlocks.rst: la guida di Linus Torvalds agli
spinlock del kernel.
- Unix Systems for Modern Architectures: Symmetric Multiprocessing and
diff --git a/Documentation/translations/it_IT/process/adding-syscalls.rst b/Documentation/translations/it_IT/process/adding-syscalls.rst
index df8c652d004b..55e511050847 100644
--- a/Documentation/translations/it_IT/process/adding-syscalls.rst
+++ b/Documentation/translations/it_IT/process/adding-syscalls.rst
@@ -39,7 +39,7 @@ vostra interfaccia.
un qualche modo opaca.
- Se dovete esporre solo delle informazioni sul sistema, un nuovo nodo in
- sysfs (vedere ``Documentation/filesystems/sysfs.rst``) o
+ sysfs (vedere Documentation/filesystems/sysfs.rst) o
in procfs potrebbe essere sufficiente. Tuttavia, l'accesso a questi
meccanismi richiede che il filesystem sia montato, il che potrebbe non
essere sempre vero (per esempio, in ambienti come namespace/sandbox/chroot).
diff --git a/Documentation/translations/it_IT/process/submit-checklist.rst b/Documentation/translations/it_IT/process/submit-checklist.rst
index 828c8f27d492..770e5601adc2 100644
--- a/Documentation/translations/it_IT/process/submit-checklist.rst
+++ b/Documentation/translations/it_IT/process/submit-checklist.rst
@@ -47,7 +47,7 @@ sottomissione delle patch, in particolare
6) Le opzioni ``CONFIG``, nuove o modificate, non scombussolano il menu
di configurazione e sono preimpostate come disabilitate a meno che non
- soddisfino i criteri descritti in ``Documentation/kbuild/kconfig-language.rst``
+ soddisfino i criteri descritti in Documentation/kbuild/kconfig-language.rst
alla punto "Voci di menu: valori predefiniti".
7) Tutte le nuove opzioni ``Kconfig`` hanno un messaggio di aiuto.
@@ -89,12 +89,12 @@ sottomissione delle patch, in particolare
16) Tutti i nuovi elementi in ``/proc`` sono documentati in ``Documentation/``.
17) Tutti i nuovi parametri d'avvio del kernel sono documentati in
- ``Documentation/admin-guide/kernel-parameters.rst``.
+ Documentation/admin-guide/kernel-parameters.rst.
18) Tutti i nuovi parametri dei moduli sono documentati con ``MODULE_PARM_DESC()``.
19) Tutte le nuove interfacce verso lo spazio utente sono documentate in
- ``Documentation/ABI/``. Leggete ``Documentation/ABI/README.rst`` per maggiori
+ ``Documentation/ABI/``. Leggete Documentation/ABI/README.rst per maggiori
informazioni. Le patch che modificano le interfacce utente dovrebbero
essere inviate in copia anche a linux-api@xxxxxxxxxxxxxxx.
@@ -118,7 +118,7 @@ sottomissione delle patch, in particolare
sorgenti che ne spieghi la logica: cosa fanno e perché.
24) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate
- ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
+ Documentation/userspace-api/ioctl/ioctl-number.rst.
25) Se il codice che avete modificato dipende o usa una qualsiasi interfaccia o
funzionalità del kernel che è associata a uno dei seguenti simboli
diff --git a/Documentation/translations/sp_SP/process/adding-syscalls.rst b/Documentation/translations/sp_SP/process/adding-syscalls.rst
index f21504c612b2..f143d4eea5eb 100644
--- a/Documentation/translations/sp_SP/process/adding-syscalls.rst
+++ b/Documentation/translations/sp_SP/process/adding-syscalls.rst
@@ -39,7 +39,7 @@ a su interfaz.
API algo opaca.
- Si sólo está exponiendo información del runtime, un nuevo nodo en sysfs
- (mire ``Documentation/filesystems/sysfs.rst``) o el filesystem ``/proc``
+ (mire Documentation/filesystems/sysfs.rst) o el filesystem ``/proc``
podría ser más adecuado. Sin embargo, acceder a estos mecanismos
requiere que el filesystem relevante esté montado, lo que podría no ser
siempre el caso (e.g. en un ambiente namespaced/sandboxed/chrooted).
diff --git a/Documentation/translations/sp_SP/process/submit-checklist.rst b/Documentation/translations/sp_SP/process/submit-checklist.rst
index b8072be18532..d79b0e7b478d 100644
--- a/Documentation/translations/sp_SP/process/submit-checklist.rst
+++ b/Documentation/translations/sp_SP/process/submit-checklist.rst
@@ -51,7 +51,7 @@ y en otros lugares con respecto al envío de parches del kernel de Linux.
6) Cualquier opción ``CONFIG`` nueva o modificada no altera el menú de
configuración y se desactiva por defecto, a menos que cumpla con los
criterios de excepción documentados en
- ``Documentation/kbuild/kconfig-language.rst`` Atributos del menú: valor por defecto.
+ Documentation/kbuild/kconfig-language.rst Atributos del menú: valor por defecto.
7) Todas las nuevas opciones de ``Kconfig`` tienen texto de ayuda.
@@ -91,13 +91,13 @@ y en otros lugares con respecto al envío de parches del kernel de Linux.
``Documentation/``.
16) Todos los nuevos parámetros de arranque del kernel están documentados
- en ``Documentation/admin-guide/kernel-parameters.rst``.
+ en Documentation/admin-guide/kernel-parameters.rst.
17) Todos los nuevos parámetros del módulo están documentados con
``MODULE_PARM_DESC()``.
18) Todas las nuevas interfaces de espacio de usuario están documentadas
- en ``Documentation/ABI/``. Consulte ``Documentation/ABI/README.rst`` para
+ en ``Documentation/ABI/``. Consulte Documentation/ABI/README.rst para
obtener más información. Los parches que cambian las interfaces del
espacio de usuario deben ser CCed a linux-api@xxxxxxxxxxxxxxx.
@@ -120,7 +120,7 @@ y en otros lugares con respecto al envío de parches del kernel de Linux.
la lógica de lo que están haciendo y por qué.
23) Si se añaden algún ioctl en el parche, actualice también
- ``Documentation/userspace-api/ioctl/ioctl-number.rst``.
+ Documentation/userspace-api/ioctl/ioctl-number.rst.
24) Si su código fuente modificado depende o utiliza cualquiera de las
API o características del kernel que están relacionadas con los
diff --git a/Documentation/translations/zh_CN/doc-guide/sphinx.rst b/Documentation/translations/zh_CN/doc-guide/sphinx.rst
index 23eac67fbc30..b24fbdde4e0d 100644
--- a/Documentation/translations/zh_CN/doc-guide/sphinx.rst
+++ b/Documentation/translations/zh_CN/doc-guide/sphinx.rst
@@ -134,7 +134,7 @@ Sphinx构建
添加新文档很容易，只需：
1. 在 ``Documentation`` 下某处添加一个新的 ``.rst`` 文件。
-2. 从 ``Documentation/index.rst`` 中的Sphinx `主目录树`_ 链接到它。
+2. 从 Documentation/index.rst 中的Sphinx `主目录树`_ 链接到它。
.. _主目录树: http://www.sphinx-doc.org/en/stable/markup/toctree.html
diff --git a/Documentation/translations/zh_CN/process/submit-checklist.rst b/Documentation/translations/zh_CN/process/submit-checklist.rst
index 0942021202a3..50c2f31906dd 100644
--- a/Documentation/translations/zh_CN/process/submit-checklist.rst
+++ b/Documentation/translations/zh_CN/process/submit-checklist.rst
@@ -42,7 +42,7 @@ Linux内核补丁提交检查单
违规行为。
6) 任何新的或修改过的 ``CONFIG`` 选项都不应搞乱配置菜单，并默认为关闭，除非
- 它们符合 ``Documentation/kbuild/kconfig-language.rst`` 菜单属性：默认值中
+ 它们符合 Documentation/kbuild/kconfig-language.rst 菜单属性：默认值中
记录的例外条件。
7) 所有新的 ``kconfig`` 选项都有帮助文本。
@@ -83,7 +83,7 @@ Linux内核补丁提交检查单
17) 所有新的模块参数都记录在 ``MODULE_PARM_DESC()``
18) 所有新的用户空间接口都记录在 ``Documentation/ABI/`` 中。有关详细信息，
- 请参阅 ``Documentation/ABI/README.rst`` 。更改用户空间接口的补丁应该抄送
+ 请参阅 Documentation/ABI/README.rst 。更改用户空间接口的补丁应该抄送
linux-api@xxxxxxxxxxxxxxx。
19) 已通过至少注入slab和page分配失败进行检查。请参阅 ``Documentation/fault-injection/`` 。
@@ -100,7 +100,7 @@ Linux内核补丁提交检查单
释来解释它们正在执行的操作及其原因的逻辑。
23) 如果补丁添加了任何ioctl，那么也要更新
- ``Documentation/userspace-api/ioctl/ioctl-number.rst`` 。
+ Documentation/userspace-api/ioctl/ioctl-number.rst 。
24) 如果修改后的源代码依赖或使用与以下 ``Kconfig`` 符号相关的任何内核API或
功能，则在禁用相关 ``Kconfig`` 符号和/或 ``=m`` （如果该选项可用）的情况
diff --git a/Documentation/translations/zh_TW/process/submit-checklist.rst b/Documentation/translations/zh_TW/process/submit-checklist.rst
index efece58cb5b2..560bb30ac0f7 100644
--- a/Documentation/translations/zh_TW/process/submit-checklist.rst
+++ b/Documentation/translations/zh_TW/process/submit-checklist.rst
@@ -45,7 +45,7 @@ Linux內核補丁提交檢查單
違規行爲。
6) 任何新的或修改過的 ``CONFIG`` 選項都不應搞亂配置菜單，並默認爲關閉，除非
- 它們符合 ``Documentation/kbuild/kconfig-language.rst`` 菜單屬性：默認值中
+ 它們符合 Documentation/kbuild/kconfig-language.rst 菜單屬性：默認值中
記錄的例外條件。
7) 所有新的 ``kconfig`` 選項都有幫助文本。
@@ -86,7 +86,7 @@ Linux內核補丁提交檢查單
17) 所有新的模塊參數都記錄在 ``MODULE_PARM_DESC()``
18) 所有新的用戶空間接口都記錄在 ``Documentation/ABI/`` 中。有關詳細信息，
- 請參閱 ``Documentation/ABI/README.rst`` 。更改用戶空間接口的補丁應該抄送
+ 請參閱 Documentation/ABI/README.rst 。更改用戶空間接口的補丁應該抄送
linux-api@xxxxxxxxxxxxxxx。
19) 已通過至少注入slab和page分配失敗進行檢查。請參閱 ``Documentation/fault-injection/`` 。
@@ -103,7 +103,7 @@ Linux內核補丁提交檢查單
釋來解釋它們正在執行的操作及其原因的邏輯。
23) 如果補丁添加了任何ioctl，那麼也要更新
- ``Documentation/userspace-api/ioctl/ioctl-number.rst`` 。
+ Documentation/userspace-api/ioctl/ioctl-number.rst 。
24) 如果修改後的源代碼依賴或使用與以下 ``Kconfig`` 符號相關的任何內核API或
功能，則在禁用相關 ``Kconfig`` 符號和/或 ``=m`` （如果該選項可用）的情況
diff --git a/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst b/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst
index 42cdb0a9f786..6e796775c740 100644
--- a/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst
+++ b/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst
@@ -430,7 +430,7 @@ MPEG stream.
*Historical context*: This format specification originates from a
custom, embedded, sliced VBI data format used by the ``ivtv`` driver.
This format has already been informally specified in the kernel sources
-in the file ``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst`` . The
+in the file Documentation/userspace-api/media/drivers/cx2341x-uapi.rst . The
maximum size of the payload and other aspects of this format are driven
by the CX23415 MPEG decoder's capabilities and limitations with respect
to extracting, decoding, and displaying sliced VBI data embedded within
diff --git a/Documentation/userspace-api/media/v4l/diff-v4l.rst b/Documentation/userspace-api/media/v4l/diff-v4l.rst
index 33243ecb5033..b087835a147f 100644
--- a/Documentation/userspace-api/media/v4l/diff-v4l.rst
+++ b/Documentation/userspace-api/media/v4l/diff-v4l.rst
@@ -634,7 +634,7 @@ devices is documented in :ref:`extended-controls`.
compatible with V4L or V4L2.
.. [#f2]
- According to ``Documentation/admin-guide/devices.rst`` a symbolic link to
+ According to Documentation/admin-guide/devices.rst a symbolic link to
``/dev/radio0``.
.. [#f3]
diff --git a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
index 2a165ae063fb..957c8a54fbfc 100644
--- a/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
+++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst
@@ -109,7 +109,7 @@ enum v4l2_mpeg_stream_vbi_fmt -
* - ``V4L2_MPEG_STREAM_VBI_FMT_IVTV``
- VBI in private packets, IVTV format (documented in the kernel
sources in the file
- ``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst``)
+ Documentation/userspace-api/media/drivers/cx2341x-uapi.rst)
diff --git a/Documentation/virt/uml/user_mode_linux_howto_v2.rst b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
index d1cfe415e4c4..d7959b081458 100644
--- a/Documentation/virt/uml/user_mode_linux_howto_v2.rst
+++ b/Documentation/virt/uml/user_mode_linux_howto_v2.rst
@@ -1083,7 +1083,7 @@ new feature, please send it to ``linux-um@xxxxxxxxxxxxxxxxxxx``.
Please follow all standard Linux patch guidelines such as cc-ing
relevant maintainers and run ``./scripts/checkpatch.pl`` on your patch.
-For more details see ``Documentation/process/submitting-patches.rst``
+For more details see Documentation/process/submitting-patches.rst
Note - the list does not accept HTML or attachments, all emails must
be formatted as plain text.
--
2.34.1
