Skip to content

Some documentation fixes

Mauro Carvalho Chehab lkml 1 version Applied

Status from this message: Applied, thank you.

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest4 patches 3 repliesApplied

Patches in v1 Applied

#Subject and filesSizeRepliesApplied
1/4input: xpad.rst: usb/devices is now at /sys/kernel/debug/Documentation/input/devices/xpad.rst+3 -31 reply
2/4input: xpad.rst: Don't use literal blocks inside footnotesDocumentation/input/devices/xpad.rst+25 -261 reply
3/4input: xpad.rst: proc/bus/usb was renamed to dev/bus/usbDocumentation/input/devices/xpad.rst+1 -11 reply
4/4input: add kAPI and uAPI kernel-doc stuff at the input bookDocumentation/driver-api/iio/intro.rst Documentation/driver-api/index.rst Documentation/input/input_kapi.rst +3 more+12 -50 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/4] Some documentation fixes

This patch series address a few issues at the documentation, after applying this patch series:
https://lkml.org/lkml/2017/4/16/2

The first patch solves a limitation with Sphinx and literal blocks inside a footnote.

The next two patches fix issues with xpad.rst documentation, with mentions /proc/bus/usb/, with used to be part of usbfs. When usbfs got removed, the old location changed. So, update accordingly.

The final patch is RFC: it adds the uapi input.h file to the documentation and groups the kAPI documentation generated from the source code together with the kAPI part of the linux-input book. We need to discuss it with documentation maintainers, to get an agreement if this is the best way to handle it.

Mauro Carvalho Chehab (4):
input: xpad.rst: usb/devices is now at /sys/kernel/debug/
input: xpad.rst: Don't use literal blocks inside footnotes
input: xpad.rst: proc/bus/usb was renamed to dev/bus/usb [RFC] input: add kAPI and uAPI kernel-doc stuff at the input book

 Documentation/driver-api/iio/intro.rst             |  4 +-
 Documentation/driver-api/index.rst                 |  1 -
 Documentation/input/devices/xpad.rst               | 53 +++++++++++-----------
 Documentation/input/input_kapi.rst                 |  1 +
 .../input.rst => input/input_kapi_symbols.rst}     |  6 ++-
 Documentation/input/input_uapi.rst                 |  1 +
 Documentation/input/input_uapi_symbols.rst         |  4 ++
 7 files changed, 38 insertions(+), 32 deletions(-)
 rename Documentation/{driver-api/input.rst => input/input_kapi_symbols.rst} (93%)
 create mode 100644 Documentation/input/input_uapi_symbols.rst
Signature · 1 line
2.9.3