Skip to content

Device links documentation

Lukas Wunner linux-iommu linux-pm linux-samsung-soc lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest2 patches 16 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/2Documentation/core-api/device_link: Add initial documentationDocumentation/core-api/device_link.rst Documentation/core-api/index.rst+287 -06 replies
2/2driver core: Silence device links sphinx warningdrivers/base/core.c include/linux/device.h+3 -25 replies

Reviews trailers per patch

All 2 patches have a Reviewed-by or Acked-by.

PatchMauro Carvalho ChehabRafael J. Wysocki
1/2R-b
2/2R-b A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH 0/2] Device links documentation

Here's my suggestion for initial documentation on the device links feature that's queued for 4.10 on Greg KH's driver-core-next branch. Please let me know if you have any additions or corrections.

To read this in rendered form:
http://wunner.de/kernel-doc/core-api/device_link.html

Patch [2/2] could go in via driver-core-next, but patch [1/2] would need to go in via docs-next (because the core-api directory doesn't exist yet in driver-core-next).

@Jonathan Corbet: Is core-api the right place to put this? An alternative would be Documentation/driver-api, but unlike core-api it contains less prose text but mostly just bare API docs gleaned from kernel-doc.

To render the documentation oneself, the device links patches need to be merged from driver-core-next into docs-next. Here's a branch which contains all the necessary bits:
https://github.com/l1k/linux/commits/device_links_docs_v1

(The build is currently broken for docs-next, one needs to remove 80211.xml from Documentation/DocBook/Makefile and for some reason $BUILDDIR/cec.h.rst is not found on the first build, but only on the second build.)

About half of the documentation was distilled from the mailing list discussion initiated by Luis Rodriguez after KS/LPC:
https://lkml.org/lkml/2016/11/7/790
https://lkml.org/lkml/2016/11/7/795
https://lkml.org/lkml/2016/11/8/899

The other half is based on the first draft I posted in September:
https://lkml.org/lkml/2016/9/27/215

Thanks,

Lukas

Lukas Wunner (2):
Documentation/core-api/device_link: Add initial documentation driver core: Silence device links sphinx warning

 Documentation/core-api/device_link.rst | 279 +++++++++++++++++++++++++++++++++
 Documentation/core-api/index.rst       |   8 +
 drivers/base/core.c                    |   4 +-
 include/linux/device.h                 |   1 +
 4 files changed, 290 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/core-api/device_link.rst
Signature · 1 line
2.10.2