staging: comedi: comedidev.h: Document usage of 'detach' handler
authorIan Abbott <abbotti@mev.co.uk>
Thu, 8 Dec 2016 13:53:10 +0000 (13:53 +0000)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 8 Dec 2016 20:01:23 +0000 (21:01 +0100)
commit3e0f9b2ca8e4839335e4d64ec0a75f4fd5111c4b
tree888fe093d6b8eab537059b032c8779f69dd90ced
parent3c87f653af6f5a94d30786903fe79f5816ec08f3
staging: comedi: comedidev.h: Document usage of 'detach' handler

Document when the "detach" handler function pointed to by the `detach`
member of a `struct comedi_driver` is called by the comedi core, and how
the "attach" and "auto_attach" handlers can defer clean-up to it when
they return an error to the comedi core.  This is already mentioned as
part of the documentation for `comedi_auto_config()`, but is useful to
document it for `struct comedi_driver` as well, since
`comedi_auto_config()` is not usually called directly by low-level
comedi drivers, and it is not called at all for "legacy" comedi devices
that are configured manually.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/staging/comedi/comedidev.h