staging: ipack: Documentation cleanups.

Signed-off-by: Jens Taprogge <jens.taprogge@taprogge.org>
Signed-off-by: Samuel Iglesias Gonsalvez <siglesias@igalia.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/drivers/staging/ipack/Kconfig b/drivers/staging/ipack/Kconfig
index 9b4495a35f91a416f53423cc3778cf67d5f26c03..5cf43b3364ebfd1082de3fb83f976f88949dfa60 100644 (file)
--- a/drivers/staging/ipack/Kconfig
+++ b/drivers/staging/ipack/Kconfig
@@ -6,11 +6,14 @@ menuconfig IPACK_BUS
        tristate "IndustryPack bus support"
        depends on HAS_IOMEM
        ---help---
-         If you say Y here you get support for the IndustryPack Framework
-         for drivers for many types of boards that support this industrial
-         bus. The IndustryPack Framework is a virtual bus allowing to
-         communicate between carrier and mezzanine cards connected through
-         this bus.
+         This option provides support for the IndustryPack framework.  There
+         are IndustryPack carrier boards, which interface another bus (such as
+         PCI) to an IndustryPack bus, and IndustryPack modules, that are
+         hosted on these buses.  While IndustryPack modules can provide a
+         large variety of functionality, they are most often found in
+         industrial control applications.
+
+         Say N if unsure.
 
 if IPACK_BUS
 

diff --git a/drivers/staging/ipack/carriers/Kconfig b/drivers/staging/ipack/carriers/Kconfig
index 33fdc2456c0c3df72954d07aaf7887c67a76a8d5..922ff5c35accdd00b25f9487666744f9b431cc8b 100644 (file)
--- a/drivers/staging/ipack/carriers/Kconfig
+++ b/drivers/staging/ipack/carriers/Kconfig
@@ -1,7 +1,7 @@
 config BOARD_TPCI200
-       tristate "TEWS TPCI-200 support for IndustryPack bus"
+       tristate "Support for the TEWS TPCI-200 IndustryPack carrier board"
        depends on IPACK_BUS
        depends on PCI
        help
-         This driver supports the TEWS TPCI200 device for the IndustryPack bus.
+         This driver adds support for the TEWS TPCI200 IndustryPack carrier board.
        default n

diff --git a/drivers/staging/ipack/ipack.h b/drivers/staging/ipack/ipack.h
index 689af9239dcedb928d44baefc1dd06ccb5ee03f0..7ca8789459e96066d84b05b6df0163183b1d5a48 100644 (file)
--- a/drivers/staging/ipack/ipack.h
+++ b/drivers/staging/ipack/ipack.h
@@ -80,10 +80,11 @@ struct ipack_device {
 };
 
 /**
- *     struct ipack_driver_ops -- callbacks to mezzanine driver for installing/removing one device
+ * struct ipack_driver_ops -- Callbacks to IPack device driver
  *
- *     @probe: Probe function
- *     @remove: tell the driver that the carrier board wants to remove one device
+ * @probe:  Probe function
+ * @remove: Prepare imminent removal of the device.  Services provided by the
+ *          device should be revoked.
  */
 
 struct ipack_driver_ops {
@@ -92,10 +93,10 @@ struct ipack_driver_ops {
 };
 
 /**
- *     struct ipack_driver -- Specific data to each ipack board driver
+ * struct ipack_driver -- Specific data to each ipack device driver
  *
- *     @driver: Device driver kernel representation
- *     @ops: Mezzanine driver operations specific for the ipack bus.
+ * @driver: Device driver kernel representation
+ * @ops:    Callbacks provided by the IPack device driver
  */
 struct ipack_driver {
        struct device_driver driver;
@@ -165,7 +166,7 @@ struct ipack_bus_device *ipack_bus_register(struct device *parent, int slots,
 int ipack_bus_unregister(struct ipack_bus_device *bus);
 
 /**
- *     ipack_driver_register -- Register a new driver
+ * ipack_driver_register -- Register a new ipack device driver
  *
  * Called by a ipack driver to register itself as a driver
  * that can manage ipack devices.