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 -- 2.10.2 _______________________________________________ iommu mailing list iommu@lists.linux-foundation.org https://lists.linuxfoundation.org/mailman/listinfo/iommu
