Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932513AbbG1OfS (ORCPT ); Tue, 28 Jul 2015 10:35:18 -0400 Received: from mga03.intel.com ([134.134.136.65]:27022 "EHLO mga03.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932496AbbG1OfN (ORCPT ); Tue, 28 Jul 2015 10:35:13 -0400 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.15,563,1432623600"; d="scan'208";a="737157395" From: Daniel Baluta To: jic23@kernel.org, corbet@lwn.net, rdunlap@infradead.org 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 v3] DocBook documentation for IIO Date: Tue, 28 Jul 2015 17:37:13 +0300 Message-Id: <1438094234-2894-1-git-send-email-daniel.baluta@intel.com> X-Mailer: git-send-email 1.9.1 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1753 Lines: 45 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@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/