Skip to content

docs: avoid using ReST :doc:`foo` tag

Mauro Carvalho Chehab bpf kvm linux-acpi linux-arm-kernel linux-devicetree linux-doc linux-gpio linux-i2c linux-kselftest linux-pci linux-pm linux-security-module lkml netdev 2 versions – Applied

Status from this message: I've applied the set, thanks.

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest29 patches 12 repliesApplied
  2. v134 patches 28 repliesApplied

Changes in v2 from the cover letter

- dropped media patches (as I merged via my own tree);
- removed one patch that would conflict at linux-next (adm1177.rst);
- removed one hunk fron kunit patch that would also conflict at linux-next.

Patches in v2 Applied

#Subject and filesSizeRepliesApplied
1/29docs: devices.rst: better reference documentation docsDocumentation/driver-api/pm/devices.rst+4 -40 replies
2/29docs: dev-tools: kunit: don't use a table for docs nameDocumentation/dev-tools/kunit/api/index.rst+4 -40 replies
3/29docs: admin-guide: pm: avoid using ReST :doc:`foo` markupDocumentation/admin-guide/pm/intel_idle.rst Documentation/admin-guide/pm/intel_pstate.rst+15 -100 replies
4/29docs: admin-guide: hw-vuln: avoid using ReST :doc:`foo` markupDocumentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst+2 -12 replies
5/29docs: admin-guide: sysctl: avoid using ReST :doc:`foo` markupDocumentation/admin-guide/sysctl/abi.rst Documentation/admin-guide/sysctl/kernel.rst+21 -180 replies
6/29docs: block: biodoc.rst: avoid using ReST :doc:`foo` markupDocumentation/block/biodoc.rst+1 -10 replies
7/29docs: bpf: bpf_lsm.rst: avoid using ReST :doc:`foo` markupDocumentation/bpf/bpf_lsm.rst+7 -60 replies
8/29docs: core-api: avoid using ReST :doc:`foo` markupDocumentation/core-api/bus-virt-phys-mapping.rst Documentation/core-api/dma-api.rst Documentation/core-api/dma-isa-lpc.rst +1 more+7 -60 replies
9/29docs: dev-tools: testing-overview.rst: avoid using ReST :doc:`foo` markupDocumentation/dev-tools/testing-overview.rst+8 -80 replies
10/29docs: dev-tools: kunit: avoid using ReST :doc:`foo` markupDocumentation/dev-tools/kunit/faq.rst Documentation/dev-tools/kunit/index.rst Documentation/dev-tools/kunit/start.rst +2 more+18 -152 replies
11/29docs: devicetree: bindings: submitting-patches.rst: avoid using ReST :doc:`foo` markupDocumentation/devicetree/bindings/submitting-patches.rst+6 -52 replies
12/29docs: doc-guide: avoid using ReST :doc:`foo` markupDocumentation/doc-guide/contributing.rst+4 -40 replies
13/29docs: driver-api: avoid using ReST :doc:`foo` markupDocumentation/driver-api/ioctl.rst+1 -10 replies
14/29docs: driver-api: gpio: using-gpio.rst: avoid using ReST :doc:`foo` markupDocumentation/driver-api/gpio/using-gpio.rst+2 -21 reply
15/29docs: driver-api: surface_aggregator: avoid using ReST :doc:`foo` markupDocumentation/driver-api/surface_aggregator/clients/index.rst Documentation/driver-api/surface_aggregator/internal.rst Documentation/driver-api/surface_aggregator/overview.rst+14 -100 replies
16/29docs: driver-api: usb: avoid using ReST :doc:`foo` markupDocumentation/driver-api/usb/dma.rst+3 -30 replies
17/29docs: firmware-guide: acpi: avoid using ReST :doc:`foo` markupDocumentation/firmware-guide/acpi/dsd/data-node-references.rst Documentation/firmware-guide/acpi/dsd/graph.rst Documentation/firmware-guide/acpi/enumeration.rst+7 -51 reply
18/29docs: i2c: avoid using ReST :doc:`foo` markupDocumentation/i2c/instantiating-devices.rst Documentation/i2c/old-module-parameters.rst Documentation/i2c/smbus-protocol.rst+5 -40 replies
19/29docs: kernel-hacking: hacking.rst: avoid using ReST :doc:`foo` markupDocumentation/kernel-hacking/hacking.rst+2 -20 replies
20/29docs: networking: devlink: avoid using ReST :doc:`foo` markupDocumentation/networking/devlink/devlink-region.rst Documentation/networking/devlink/devlink-trap.rst+3 -30 replies
21/29docs: PCI: endpoint: pci-endpoint-cfs.rst: avoid using ReST :doc:`foo` markupDocumentation/PCI/endpoint/pci-endpoint-cfs.rst+1 -10 replies
22/29docs: PCI: pci.rst: avoid using ReST :doc:`foo` markupDocumentation/PCI/pci.rst+3 -31 reply
23/29docs: process: submitting-patches.rst: avoid using ReST :doc:`foo` markupDocumentation/process/submitting-patches.rst+15 -170 replies
24/29docs: security: landlock.rst: avoid using ReST :doc:`foo` markupDocumentation/security/landlock.rst+2 -10 replies
25/29docs: trace: coresight: coresight.rst: avoid using ReST :doc:`foo` markupDocumentation/trace/coresight/coresight.rst+5 -31 reply
26/29docs: trace: ftrace.rst: avoid using ReST :doc:`foo` markupDocumentation/trace/ftrace.rst+1 -10 replies
27/29docs: userspace-api: landlock.rst: avoid using ReST :doc:`foo` markupDocumentation/userspace-api/landlock.rst+6 -51 reply
28/29docs: virt: kvm: s390-pv-boot.rst: avoid using ReST :doc:`foo` markupDocumentation/virt/kvm/s390-pv-boot.rst+1 -10 replies
29/29docs: x86: avoid using ReST :doc:`foo` markupDocumentation/x86/boot.rst Documentation/x86/mtrr.rst+3 -30 replies

Reviews trailers per patch

11 of 29 patches have a Reviewed-by or Acked-by.

PatchDavid GowBrendan HigginsBjorn HelgaasWolfram SangPeter Zijlstra (Intel)Linus WalleijMaximilian LuzSakari AilusMathieu PoirierMickaël Salaün
1/29
2/29R-b A-b
3/29
4/29
5/29
6/29
7/29
8/29
9/29
10/29R-b A-b
11/29
12/29
13/29
14/29R-b
15/29A-b
16/29
17/29R-b
18/29A-b
19/29
20/29
21/29A-b
22/29A-b
23/29
24/29
25/29R-b
26/29
27/29A-b
28/29
29/29A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 10 reviewers.

Read the v2 thread

Cover letter [PATCH v2 00/29] docs: avoid using ReST :doc:`foo` tag

(Maintainers bcc, to avoid too many recipient troubles)

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.

I'll re-send the remaining patch (plus another patch) with conflicting changes, together with any other doc:filename reference that might still be upstream by 5.14-rc1.

---

v2:
- dropped media patches (as I merged via my own tree);
- removed one patch that would conflict at linux-next (adm1177.rst);
- removed one hunk fron kunit patch that would also conflict at linux-next.

Mauro Carvalho Chehab (29):
docs: devices.rst: better reference documentation docs
docs: dev-tools: kunit: don't use a table for docs name
docs: admin-guide: pm: avoid using ReST :doc:foo markup
docs: admin-guide: hw-vuln: avoid using ReST :doc:foo markup
docs: admin-guide: sysctl: avoid using ReST :doc:foo markup
docs: block: biodoc.rst: avoid using ReST :doc:foo markup
docs: bpf: bpf_lsm.rst: avoid using ReST :doc:foo markup
docs: core-api: avoid using ReST :doc:foo markup
docs: dev-tools: testing-overview.rst: avoid using ReST :doc:foo
markup
docs: dev-tools: kunit: avoid using ReST :doc:foo markup
docs: devicetree: bindings: submitting-patches.rst: avoid using ReST
:doc:foo markup
docs: doc-guide: avoid using ReST :doc:foo markup
docs: driver-api: avoid using ReST :doc:foo markup
docs: driver-api: gpio: using-gpio.rst: avoid using ReST :doc:foo
markup
docs: driver-api: surface_aggregator: avoid using ReST :doc:foo
markup
docs: driver-api: usb: avoid using ReST :doc:foo markup
docs: firmware-guide: acpi: avoid using ReST :doc:foo markup
docs: i2c: avoid using ReST :doc:foo markup
docs: kernel-hacking: hacking.rst: avoid using ReST :doc:foo markup
docs: networking: devlink: avoid using ReST :doc:foo markup
docs: PCI: endpoint: pci-endpoint-cfs.rst: avoid using ReST :doc:foo
markup
docs: PCI: pci.rst: avoid using ReST :doc:foo markup
docs: process: submitting-patches.rst: avoid using ReST :doc:foo
markup
docs: security: landlock.rst: avoid using ReST :doc:foo markup
docs: trace: coresight: coresight.rst: avoid using ReST :doc:foo
markup
docs: trace: ftrace.rst: avoid using ReST :doc:foo markup
docs: userspace-api: landlock.rst: avoid using ReST :doc:foo markup
docs: virt: kvm: s390-pv-boot.rst: avoid using ReST :doc:foo markup
docs: x86: avoid using ReST :doc:foo markup

 .../PCI/endpoint/pci-endpoint-cfs.rst         |  2 +-
 Documentation/PCI/pci.rst                     |  6 +--
 .../special-register-buffer-data-sampling.rst |  3 +-
 Documentation/admin-guide/pm/intel_idle.rst   | 16 +++++---
 Documentation/admin-guide/pm/intel_pstate.rst |  9 +++--
 Documentation/admin-guide/sysctl/abi.rst      |  2 +-
 Documentation/admin-guide/sysctl/kernel.rst   | 37 ++++++++++---------
 Documentation/block/biodoc.rst                |  2 +-
 Documentation/bpf/bpf_lsm.rst                 | 13 ++++---
 .../core-api/bus-virt-phys-mapping.rst        |  2 +-
 Documentation/core-api/dma-api.rst            |  5 ++-
 Documentation/core-api/dma-isa-lpc.rst        |  2 +-
 Documentation/core-api/index.rst              |  4 +-
 Documentation/dev-tools/kunit/api/index.rst   |  8 ++--
 Documentation/dev-tools/kunit/faq.rst         |  2 +-
 Documentation/dev-tools/kunit/index.rst       | 14 +++----
 Documentation/dev-tools/kunit/start.rst       |  4 +-
 Documentation/dev-tools/kunit/tips.rst        |  5 ++-
 Documentation/dev-tools/kunit/usage.rst       |  8 ++--
 Documentation/dev-tools/testing-overview.rst  | 16 ++++----
 .../bindings/submitting-patches.rst           | 11 +++---
 Documentation/doc-guide/contributing.rst      |  8 ++--
 Documentation/driver-api/gpio/using-gpio.rst  |  4 +-
 Documentation/driver-api/ioctl.rst            |  2 +-
 Documentation/driver-api/pm/devices.rst       |  8 ++--
 .../surface_aggregator/clients/index.rst      |  3 +-
 .../surface_aggregator/internal.rst           | 15 ++++----
 .../surface_aggregator/overview.rst           |  6 ++-
 Documentation/driver-api/usb/dma.rst          |  6 +--
 .../acpi/dsd/data-node-references.rst         |  3 +-
 .../firmware-guide/acpi/dsd/graph.rst         |  2 +-
 .../firmware-guide/acpi/enumeration.rst       |  7 ++--
 Documentation/i2c/instantiating-devices.rst   |  2 +-
 Documentation/i2c/old-module-parameters.rst   |  3 +-
 Documentation/i2c/smbus-protocol.rst          |  4 +-
 Documentation/kernel-hacking/hacking.rst      |  4 +-
 .../networking/devlink/devlink-region.rst     |  2 +-
 .../networking/devlink/devlink-trap.rst       |  4 +-
 Documentation/process/submitting-patches.rst  | 32 ++++++++--------
 Documentation/security/landlock.rst           |  3 +-
 Documentation/trace/coresight/coresight.rst   |  8 ++--
 Documentation/trace/ftrace.rst                |  2 +-
 Documentation/userspace-api/landlock.rst      | 11 +++---
 Documentation/virt/kvm/s390-pv-boot.rst       |  2 +-
 Documentation/x86/boot.rst                    |  4 +-
 Documentation/x86/mtrr.rst                    |  2 +-
 46 files changed, 171 insertions(+), 147 deletions(-)
Signature · 1 line
2.31.1