Skip to content

Update Documentation/ cross references and fix issues

Mauro Carvalho Chehab dri-devel kvm linux-arm-kernel linux-can linux-doc linux-ext4 linux-fsdevel linux-media linux-mm linux-pci linux-sgx lkml netdev 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v3 Latest21 patches 7 repliesIn review

Patches in v3 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/21docs: networking: update netdevices.rst referencedrivers/net/can/can327.c+1 -10 replies
2/21docs: update vmalloced-kernel-stacks.rst referenceDocumentation/translations/zh_CN/mm/vmalloced-kernel-stacks.rst+1 -12 replies
3/21docs: update vmemmap_dedup.rst referencemm/hugetlb_vmemmap.h+1 -11 reply
4/21docs: zh_CN: page_migration: fix reference to mm index.rstDocumentation/translations/zh_CN/mm/page_migration.rst+1 -12 replies
5/21dt-bindings: arm: update arm,coresight-cpu-debug.yaml referenceDocumentation/trace/coresight/coresight-cpu-debug.rst+1 -10 replies
6/21x86/sgx: fix kernel-doc markupsarch/x86/include/uapi/asm/sgx.h+8 -20 replies
7/21fscache: fix kernel-doc documentationinclude/linux/fscache.h+2 -20 replies
8/21fs: namei: address some kernel-doc issuesfs/namei.c+3 -00 replies
9/21drm/scheduler: fix a kernel-doc warninginclude/drm/gpu_scheduler.h+1 -01 reply
10/21drm/scheduler: add a missing kernel-doc parameterdrivers/gpu/drm/scheduler/sched_main.c+1 -00 replies
11/21kfence: fix a kernel-doc parameterinclude/linux/kfence.h+1 -00 replies
12/21genalloc: add a description for start_addr parameterinclude/linux/genalloc.h+1 -00 replies
13/21textsearch: document list inside struct ts_opsinclude/linux/textsearch.h+1 -00 replies
14/21dcache: fix a kernel-doc warninginclude/linux/dcache.h+1 -10 replies
15/21docs: ext4: blockmap.rst: fix a broken tableDocumentation/filesystems/ext4/blockmap.rst+1 -11 reply
16/21docs: PCI: pci-vntb-function.rst: Properly include ascii artworkDocumentation/PCI/endpoint/pci-vntb-function.rst+1 -10 replies
17/21docs: PCI: pci-vntb-howto.rst: fix a title markupDocumentation/PCI/endpoint/pci-vntb-howto.rst+1 -10 replies
18/21docs: virt: kvm: fix a title markup at api.rstDocumentation/virt/kvm/api.rst+3 -30 replies
19/21docs: ABI: sysfs-bus-nvdimmDocumentation/ABI/testing/sysfs-bus-nvdimm+2 -00 replies
20/21docs: leds: index.rst: add leds-qcom-lpg to itDocumentation/leds/index.rst+1 -00 replies
21/21Documentation: coresight: fix binding wildcardsDocumentation/trace/coresight/coresight.rst+1 -10 replies

Reviews trailers per patch

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

PatchAlex DeucherJarkko SakkinenDave HansenChristian BraunerMathieu PoirierMarco ElverKajol JainWu XiangChengTheodore Ts'oYanteng SiMuchun Song
1/21
2/21A-b A-b
3/21R-b
4/21A-b
5/21
6/21R-b A-b
7/21
8/21
9/21R-b R-b
10/21R-b
11/21R-b
12/21
13/21
14/21A-b
15/21A-b
16/21
17/21
18/21
19/21R-b
20/21
21/21R-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 11 reviewers.

Read the v3 thread

Cover letter [PATCH v3 00/21] Update Documentation/ cross references and fix issues

This series fix almost all fixable issues when building the html docs at linux-next (next-20220608):

- Address some broken cross-references;
- Fix kernel-doc warnings;
- Fix bad tags on ReST files.

With this series applied, plus other pending patches that should hopefully be merged in time for the next merge window, htmldocs build will produce just 4 warnings with Sphinx 2.4.4.

Sphinx >=3 will produce some extra false-positive warnings due to conflicts between structs and functions sharing the same name. Hopefully this will be fixed either on a new Sphinx 5.x version or Sphinx 6.0.

Mauro Carvalho Chehab (21):
docs: networking: update netdevices.rst reference
docs: update vmalloced-kernel-stacks.rst reference
docs: update vmemmap_dedup.rst reference
docs: zh_CN: page_migration: fix reference to mm index.rst
dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference x86/sgx: fix kernel-doc markups
fscache: fix kernel-doc documentation
fs: namei: address some kernel-doc issues drm/scheduler: fix a kernel-doc warning drm/scheduler: add a missing kernel-doc parameter
kfence: fix a kernel-doc parameter
genalloc: add a description for start_addr parameter
textsearch: document list inside struct ts_ops
dcache: fix a kernel-doc warning
docs: ext4: blockmap.rst: fix a broken table
docs: PCI: pci-vntb-function.rst: Properly include ascii artwork
docs: PCI: pci-vntb-howto.rst: fix a title markup
docs: virt: kvm: fix a title markup at api.rst
docs: ABI: sysfs-bus-nvdimm
docs: leds: index.rst: add leds-qcom-lpg to it
Documentation: coresight: fix binding wildcards

 Documentation/ABI/testing/sysfs-bus-nvdimm             |  2 ++
 Documentation/PCI/endpoint/pci-vntb-function.rst       |  2 +-
 Documentation/PCI/endpoint/pci-vntb-howto.rst          |  2 +-
 Documentation/filesystems/ext4/blockmap.rst            |  2 +-
 Documentation/leds/index.rst                           |  1 +
 Documentation/trace/coresight/coresight-cpu-debug.rst  |  2 +-
 Documentation/trace/coresight/coresight.rst            |  2 +-
 Documentation/translations/zh_CN/mm/page_migration.rst |  2 +-
 .../translations/zh_CN/mm/vmalloced-kernel-stacks.rst  |  2 +-
 Documentation/virt/kvm/api.rst                         |  6 +++---
 arch/x86/include/uapi/asm/sgx.h                        | 10 ++++++++--
 drivers/gpu/drm/scheduler/sched_main.c                 |  1 +
 drivers/net/can/can327.c                               |  2 +-
 fs/namei.c                                             |  3 +++
 include/drm/gpu_scheduler.h                            |  1 +
 include/linux/dcache.h                                 |  2 +-
 include/linux/fscache.h                                |  4 ++--
 include/linux/genalloc.h                               |  1 +
 include/linux/kfence.h                                 |  1 +
 include/linux/textsearch.h                             |  1 +
 mm/hugetlb_vmemmap.h                                   |  2 +-
 21 files changed, 34 insertions(+), 17 deletions(-)
Signature · 1 line
2.36.1