firewire: cdev: fix documentation of FW_CDEV_IOC_GET_INFO
authorStefan Richter <stefanr@s5r6.in-berlin.de>
Fri, 2 Jan 2009 11:47:13 +0000 (12:47 +0100)
committerStefan Richter <stefanr@s5r6.in-berlin.de>
Tue, 24 Mar 2009 19:56:41 +0000 (20:56 +0100)
The FW_CDEV_IOC_GET_INFO ioctl looks at client->device->config_rom, not
at the local node's config ROM.

We could fix the implementation or the documentation.  I believe the way
how it is currently implemented is more useful than the way how it is
currently documented.  In fact, libdc1394 uses the ABI already as
implemented, not as documented.  Hence let's change the documentation.

Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
include/linux/firewire-cdev.h

index 899ef279f5bebae56f88099091a6929716aecc42..86c8ff5326f9381e539c8265d9981fc71e886416 100644 (file)
@@ -201,7 +201,7 @@ union fw_cdev_event {
  *             case, @rom_length is updated with the actual length of the
  *             configuration ROM.
  * @rom:       If non-zero, address of a buffer to be filled by a copy of the
- *             local node's configuration ROM
+ *             device's configuration ROM
  * @bus_reset: If non-zero, address of a buffer to be filled by a
  *             &struct fw_cdev_event_bus_reset with the current state
  *             of the bus.  This does not cause a bus reset to happen.