firewire: cdev: ABI documentation enhancements
authorStefan Richter <stefanr@s5r6.in-berlin.de>
Thu, 14 Jul 2011 19:08:39 +0000 (21:08 +0200)
committerStefan Richter <stefanr@s5r6.in-berlin.de>
Sat, 16 Jul 2011 05:24:32 +0000 (07:24 +0200)
commitf6a7cd0212c359f7b55414aeee364ee7cac363cc
treef7d75b8040c69f21b8b1ffcbbde762c5636cac37
parent93b37905f70083d6143f5f4dba0a45cc64379a62
firewire: cdev: ABI documentation enhancements

Add overview documentation in Documentation/ABI/stable/firewire-cdev.

Improve the inline reference documentation in firewire-cdev.h:

  - Add /* available since kernel... */ comments to event numbers
    consistent with the comments on ioctl numbers.

  - Shorten some documentation on an event and an ioctl that are
    less interesting to current programming because there are newer
    preferable variants.

  - Spell Configuration ROM (name of an IEEE 1212 register) in
    upper case.

  - Move the dummy FW_CDEV_VERSION out of the reader's field of
    vision.  We should remove it from the header next year or so.

Signed-off-by: Stefan Richter <stefanr@s5r6.in-berlin.de>
Documentation/ABI/stable/firewire-cdev [new file with mode: 0644]
include/linux/firewire-cdev.h