From: Daniel Baluta <daniel.baluta@intel.com>
To: jic23@kernel.org, corbet@lwn.net, rdunlap@infradead.org, cmo@melexis.com
Cc: pmeerw@pmeerw.net, knaack.h@gmx.de, lars@metafoo.de,
linux-kernel@vger.kernel.org, linux-iio@vger.kernel.org,
herbert@gondor.apana.org.au, smueller@chronox.de, mmarek@suse.cz,
daniel.baluta@intel.com, linux-doc@vger.kernel.org,
cristina.opriceana@gmail.com
Subject: [PATCH v5] DocBook: Add initial documentation for IIO
Date: Tue, 4 Aug 2015 17:20:07 +0300 [thread overview]
Message-ID: <1438698008-13718-1-git-send-email-daniel.baluta@intel.com> (raw)
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
next reply other threads:[~2015-08-04 14:18 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-08-04 14:20 Daniel Baluta [this message]
2015-08-04 14:20 ` [PATCH v5] DocBook: Add initial documentation for IIO Daniel Baluta
2015-08-08 11:32 ` Jonathan Cameron
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1438698008-13718-1-git-send-email-daniel.baluta@intel.com \
--to=daniel.baluta@intel.com \
--cc=cmo@melexis.com \
--cc=corbet@lwn.net \
--cc=cristina.opriceana@gmail.com \
--cc=herbert@gondor.apana.org.au \
--cc=jic23@kernel.org \
--cc=knaack.h@gmx.de \
--cc=lars@metafoo.de \
--cc=linux-doc@vger.kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mmarek@suse.cz \
--cc=pmeerw@pmeerw.net \
--cc=rdunlap@infradead.org \
--cc=smueller@chronox.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).