Re: [PATCH] iio: let the doc follow core code move

From: Jonathan Cameron
Date: Thu Jun 14 2012 - 09:58:04 EST


On 6/14/2012 2:45 PM, Jiri Kosina wrote:
On Thu, 14 Jun 2012, Jonathan Cameron wrote:

As the IIO core code has been moved out of staging, let the appropriate
documentation appear in Documentation/iio (which is what
drivers/iio/Kconfig suggests as a location to look for it anyway).

I'd really rather not do this just yet. There are elements that are out
of date or downright wrong in here. Much like the drivers, these should
get some careful review before they go anywhere.

For now we have carefully only moved abi docs that have been
carefully sanity checked first (and even then a few 'interesting'
corners made it through).

Obviously we'd like to do that pretty soon!
In the meantime it comes down to that old story of wrong docs
perhaps being worse than no docs.

Oh well, I see.

So at least we need the patch below.
Fair enough I suppose.




From: Jiri Kosina<jkosina@xxxxxxx>
Subject: [PATCH] iio: drop wrong reference from Kconfig

The documentation lives in drivers/staging/iio/Documentation, but
according to Jonathan it's obsolete and needs fixing.

Signed-off-by: Jiri Kosina<jkosina@xxxxxxx>
Acked-by: Jonathan Cameron <jic23@xxxxxxxxxx>
---
drivers/iio/Kconfig | 3 +--
1 files changed, 1 insertions(+), 2 deletions(-)

diff --git a/drivers/iio/Kconfig b/drivers/iio/Kconfig
index 56eecef..2ec93da 100644
--- a/drivers/iio/Kconfig
+++ b/drivers/iio/Kconfig
@@ -8,8 +8,7 @@ menuconfig IIO
help
The industrial I/O subsystem provides a unified framework for
drivers for many different types of embedded sensors using a
- number of different physical interfaces (i2c, spi, etc). See
- Documentation/iio for more information.
+ number of different physical interfaces (i2c, spi, etc).

if IIO



--
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/