docs: avoid using ReST :doc:`foo` tag
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
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 files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/29 | docs: devices.rst: better reference documentation docsDocumentation/ | +4 | 0 replies | |
| 2/29 | docs: dev-tools: kunit: don't use a table for docs nameDocumentation/ | +4 | 0 replies | |
| 3/29 | docs: admin-guide: pm: avoid using ReST :doc:`foo` markupDocumentation/ Documentation/ | +15 | 0 replies | |
| 4/29 | docs: admin-guide: hw-vuln: avoid using ReST :doc:`foo` markupDocumentation/ | +2 | 2 replies | |
| 5/29 | docs: admin-guide: sysctl: avoid using ReST :doc:`foo` markupDocumentation/ Documentation/ | +21 | 0 replies | |
| 6/29 | docs: block: biodoc.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +1 | 0 replies | |
| 7/29 | docs: bpf: bpf_lsm.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +7 | 0 replies | |
| 8/29 | docs: core-api: avoid using ReST :doc:`foo` markupDocumentation/ Documentation/ Documentation/ +1 more | +7 | 0 replies | |
| 9/29 | docs: dev-tools: testing-overview.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +8 | 0 replies | |
| 10/29 | docs: dev-tools: kunit: avoid using ReST :doc:`foo` markupDocumentation/ Documentation/ Documentation/ +2 more | +18 | 2 replies | |
| 11/29 | docs: devicetree: bindings: submitting-patches.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +6 | 2 replies | |
| 12/29 | docs: doc-guide: avoid using ReST :doc:`foo` markupDocumentation/ | +4 | 0 replies | |
| 13/29 | docs: driver-api: avoid using ReST :doc:`foo` markupDocumentation/ | +1 | 0 replies | |
| 14/29 | docs: driver-api: gpio: using-gpio.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +2 | 1 reply | |
| 15/29 | docs: driver-api: surface_aggregator: avoid using ReST :doc:`foo` markupDocumentation/ Documentation/ Documentation/ | +14 | 0 replies | |
| 16/29 | docs: driver-api: usb: avoid using ReST :doc:`foo` markupDocumentation/ | +3 | 0 replies | |
| 17/29 | docs: firmware-guide: acpi: avoid using ReST :doc:`foo` markupDocumentation/ Documentation/ Documentation/ | +7 | 1 reply | |
| 18/29 | docs: i2c: avoid using ReST :doc:`foo` markupDocumentation/ Documentation/ Documentation/ | +5 | 0 replies | |
| 19/29 | docs: kernel-hacking: hacking.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +2 | 0 replies | |
| 20/29 | docs: networking: devlink: avoid using ReST :doc:`foo` markupDocumentation/ Documentation/ | +3 | 0 replies | |
| 21/29 | docs: PCI: endpoint: pci-endpoint-cfs.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +1 | 0 replies | |
| 22/29 | docs: PCI: pci.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +3 | 1 reply | |
| 23/29 | docs: process: submitting-patches.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +15 | 0 replies | |
| 24/29 | docs: security: landlock.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +2 | 0 replies | |
| 25/29 | docs: trace: coresight: coresight.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +5 | 1 reply | |
| 26/29 | docs: trace: ftrace.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +1 | 0 replies | |
| 27/29 | docs: userspace-api: landlock.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +6 | 1 reply | |
| 28/29 | docs: virt: kvm: s390-pv-boot.rst: avoid using ReST :doc:`foo` markupDocumentation/ | +1 | 0 replies | |
| 29/29 | docs: x86: avoid using ReST :doc:`foo` markupDocumentation/ Documentation/ | +3 | 0 replies |
Reviews trailers per patch
11 of 29 patches have a Reviewed-by or Acked-by.
| Patch | David Gow | Brendan Higgins | Bjorn Helgaas | Wolfram Sang | Peter Zijlstra (Intel) | Linus Walleij | Maximilian Luz | Sakari Ailus | Mathieu Poirier | Mickaël Salaün |
|---|---|---|---|---|---|---|---|---|---|---|
| 1/29 | ||||||||||
| 2/29 | R-b | A-b | ||||||||
| 3/29 | ||||||||||
| 4/29 | ||||||||||
| 5/29 | ||||||||||
| 6/29 | ||||||||||
| 7/29 | ||||||||||
| 8/29 | ||||||||||
| 9/29 | ||||||||||
| 10/29 | R-b | A-b | ||||||||
| 11/29 | ||||||||||
| 12/29 | ||||||||||
| 13/29 | ||||||||||
| 14/29 | R-b | |||||||||
| 15/29 | A-b | |||||||||
| 16/29 | ||||||||||
| 17/29 | R-b | |||||||||
| 18/29 | A-b | |||||||||
| 19/29 | ||||||||||
| 20/29 | ||||||||||
| 21/29 | A-b | |||||||||
| 22/29 | A-b | |||||||||
| 23/29 | ||||||||||
| 24/29 | ||||||||||
| 25/29 | R-b | |||||||||
| 26/29 | ||||||||||
| 27/29 | A-b | |||||||||
| 28/29 | ||||||||||
| 29/29 | A-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.
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