[PATCH v5] DocBook: Add initial documentation for IIO

From: Daniel Baluta
Date: Tue Aug 04 2015 - 10:18:13 EST


In our effort to support vendors writing drivers for their own
sensors we introduce IIO documentation in DocBook format.

It documents Industrial I/O core including IIO devices, buffers, triggers and
triggered buffers. It also offers a short list of online resources
for the IIO subsystem.

This is far from being complete any suggestions are welcomed. At a first
glance we also need to add documentation for events. We are also working
on auto-generating template drivers based on the type of the IIO sensors.

Generated html files should be available online here http://dbaluta.github.io/
or you could run make htmldocs in the root of your kernel repo to get them.

Changes since v4:
* addressed feedback from Peter Meerwald
* http://marc.info/?l=linux-iio&m=143859386402036&w=2

Changes since v3:
* addressed feedback from Crt Mori
* http://marc.info/?l=linux-iio&m=143815719008296&w=2

Changes since v2:
* addressed feedback from Lars-Peter
* http://marc.info/?l=linux-iio&m=143774991802816&w=2
* Many thanks to Lars-Peter Clausen for scan_index paragraph.

Changes since v1:
* mostly typos and clarifications
* addressed comments from Jonathan Corbet and Jonathan Cameron
* http://marc.info/?l=linux-iio&m=143704226629498&w=2
* http://marc.info/?l=linux-iio&m=143707511006898&w=2
* for DocBook warnings reported by Randy, Cristina sent
this patchseries:
http://marc.info/?l=linux-iio&m=143774363900903&w=2

Daniel Baluta (1):
DocBook: Add initial documentation for IIO

Documentation/DocBook/Makefile | 2 +-
Documentation/DocBook/iio.tmpl | 697 +++++++++++++++++++++++++++++++++++++++++
2 files changed, 698 insertions(+), 1 deletion(-)
create mode 100644 Documentation/DocBook/iio.tmpl

--
1.9.1

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/