Skip to content

Address several documentation build warnings

Mauro Carvalho Chehab linux-arm-kernel linux-doc linux-fsdevel linux-gpio linux-i2c linux-ide linux-pci linux-pm linux-rdma lkml netdev rcu 1 version Applied

Status from this message: Applied, thank you!

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest17 patches 24 repliesApplied

Patches in v1 Applied

#Subject and filesSizeRepliesApplied
1/17docs: amu: supress some Sphinx warningsDocumentation/arm64/amu.rst+5 -00 replies
2/17docs: arm64: booting.rst: get rid of some warningsDocumentation/arm64/booting.rst+22 -140 replies
3/17docs: pci: boot-interrupts.rst: improve html outputDocumentation/PCI/boot-interrupts.rst+19 -151 reply
4/17kernel: futex.c: get rid of a docs build warningkernel/futex.c+2 -17 replies
5/17devfreq: devfreq.h: get rid of some doc warningsinclude/linux/devfreq.h+3 -31 reply
6/17firewire: firewire-cdev.hL get rid of a docs warninginclude/uapi/linux/firewire-cdev.h+1 -11 reply
7/17scripts: kernel-doc: proper handle @foo->bar()scripts/kernel-doc+2 -00 replies
8/17lib: bitmap.c: get rid of some doc warningslib/bitmap.c+14 -130 replies
9/17rcu: update.c: get rid of some doc warningskernel/rcu/update.c+4 -41 reply
10/17net: phy: sfp-bus.c: get rid of docs warningsdrivers/net/phy/sfp-bus.c+18 -141 reply
11/17net: core: dev.c: fix a documentation warningnet/core/dev.c+1 -11 reply
12/17gpio: gpiolib.c: fix a doc warningdrivers/gpio/gpiolib.c+1 -14 replies
13/17i2c: include/linux/i2c.h: fix a doc warninginclude/linux/i2c.h+2 -23 replies
14/17infiniband: pa_vnic_encap.h: get rid of a warningdrivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h+1 -13 replies
15/17ata: libata-core: fix a doc warningdrivers/ata/libata-core.c+1 -10 replies
16/17fs: inode.c: get rid of docs warningsfs/inode.c+3 -30 replies
17/17regulator: driver.h: fix regulator_map_* function namesinclude/linux/regulator/driver.h+2 -21 reply

Reviews trailers per patch

5 of 17 patches have a Reviewed-by or Acked-by.

PatchWolfram SangStefan RichterBjorn HelgaasBartosz GolaszewskiJason GunthorpeLinus Walleij
1/17
2/17
3/17A-b
4/17
5/17
6/17A-b
7/17
8/17
9/17
10/17
11/17
12/17R-b R-b
13/17A-b
14/17A-b
15/17
16/17
17/17

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

Read the v1 thread

Cover letter [PATCH 00/17] Address several documentation build warnings

This patch series is against next-20200317. It addresses several warnings on random places.

It is worth noticing patch 07/17: It changes kernel-doc parser to accept a very common pattern on kernel-doc markups. This reduces a lot of warnings all over the tree.

The remaining patches are just random fixes with the hope to address most warnings that are shown in red when building the documentation.

Mauro Carvalho Chehab (17):
docs: amu: supress some Sphinx warnings
docs: arm64: booting.rst: get rid of some warnings
docs: pci: boot-interrupts.rst: improve html output
kernel: futex.c: get rid of a docs build warning
devfreq: devfreq.h: get rid of some doc warnings
firewire: firewire-cdev.hL get rid of a docs warning
scripts: kernel-doc: proper handle @foo->bar()
lib: bitmap.c: get rid of some doc warnings
rcu: update.c: get rid of some doc warnings
net: phy: sfp-bus.c: get rid of docs warnings
net: core: dev.c: fix a documentation warning
gpio: gpiolib.c: fix a doc warning
i2c: include/linux/i2c.h: fix a doc warning
infiniband: pa_vnic_encap.h: get rid of a warning
ata: libata-core: fix a doc warning
fs: inode.c: get rid of docs warnings
regulator: driver.h: fix regulator_map_* function names

 Documentation/PCI/boot-interrupts.rst         | 34 ++++++++++--------
 Documentation/arm64/amu.rst                   |  5 +++
 Documentation/arm64/booting.rst               | 36 +++++++++++--------
 drivers/ata/libata-core.c                     |  2 +-
 drivers/gpio/gpiolib.c                        |  2 +-
 .../infiniband/ulp/opa_vnic/opa_vnic_encap.h  |  2 +-
 drivers/net/phy/sfp-bus.c                     | 32 +++++++++--------
 fs/inode.c                                    |  6 ++--
 include/linux/devfreq.h                       |  6 ++--
 include/linux/i2c.h                           |  4 +--
 include/linux/regulator/driver.h              |  4 +--
 include/uapi/linux/firewire-cdev.h            |  2 +-
 kernel/futex.c                                |  3 +-
 kernel/rcu/update.c                           |  8 ++---
 lib/bitmap.c                                  | 27 +++++++-------
 net/core/dev.c                                |  2 +-
 scripts/kernel-doc                            |  2 ++
 17 files changed, 101 insertions(+), 76 deletions(-)
Signature · 1 line
2.24.1