Re: Documentation/pci.txt inconsistency

[Rolf Eike Beer]

Greg KH wrote:
> On Wed, Nov 17, 2004 at 01:34:56PM +0100, Rolf Eike Beer wrote:
> > The examples in section 2 of Documentation/pci.txt use pci_get_*. Some
> > lines
> >
> > later there is this funny little paragraph:
> > > Note that these functions are not hotplug-safe.  Their hotplug-safe
> > > replacements are pci_get_device(), pci_get_class() and
> > > pci_get_subsys(). They increment the reference count on the pci_dev
> > > that they return. You must eventually (possibly at module unload)
> > > decrement the reference count on these devices by calling
> > > pci_dev_put().
> >
> > How about this:
> >
> > These functions are hotplug-safe. They increment the reference count on
> > the pci_dev that they return. You must eventually (possibly at module
> > unload) decrement the reference count on these devices by calling
> > pci_dev_put().
>
> Great, care to send a patch instead?

Signed-off-by: Rolf Eike Beer <eike-kernel@xxxxxxxxx>

--- linux-2.6.9/Documentation/pci.txt	2004-11-18 09:43:56.927721824 +0100
+++ linux-2.6.10-rc2/Documentation/pci.txt	2004-11-18 10:09:06.070297280 +0100
@@ -156,11 +156,9 @@
 VENDOR_ID or DEVICE_ID.  This allows searching for any device from a
 specific vendor, for example.
 
-Note that these functions are not hotplug-safe.  Their hotplug-safe
-replacements are pci_get_device(), pci_get_class() and pci_get_subsys().
-They increment the reference count on the pci_dev that they return.
-You must eventually (possibly at module unload) decrement the reference
-count on these devices by calling pci_dev_put().
+   These functions are hotplug-safe. They increment the reference count on
+the pci_dev that they return. You must eventually (possibly at module unload)
+decrement the reference count on these devices by calling pci_dev_put().
 
 
 3. Enabling and disabling devices
-
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/