linux-kernel - [PATCH v3] DocBook documentation for IIO

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <1438094234-2894-1-git-send-email-daniel.baluta@intel.com>
Date:	Tue, 28 Jul 2015 17:37:13 +0300
From:	Daniel Baluta <daniel.baluta@...el.com>
To:	jic23@...nel.org, corbet@....net, rdunlap@...radead.org
Cc:	pmeerw@...erw.net, knaack.h@....de, lars@...afoo.de,
	linux-kernel@...r.kernel.org, linux-iio@...r.kernel.org,
	herbert@...dor.apana.org.au, smueller@...onox.de, mmarek@...e.cz,
	daniel.baluta@...el.com, linux-doc@...r.kernel.org,
	cristina.opriceana@...il.com
Subject: [PATCH v3] DocBook documentation for IIO

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.

Many thanks to Lars-Peter Clausen for scan_index paragraph.

Changes since v2:
	* addressed feedback from Lars-Peter
	  * http://marc.info/?l=linux-iio&m=143774991802816&w=2

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 | 701 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 702 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@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/