media: media-entity: Clarify media_entity_cleanup() usage
authorLaurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Thu, 24 Feb 2022 12:57:47 +0000 (14:57 +0200)
committerSakari Ailus <sakari.ailus@linux.intel.com>
Thu, 3 Mar 2022 22:27:09 +0000 (00:27 +0200)
commit443bf23d0048e014065d1a7fac8144fb0a40805b
tree2abbf6f1fda54cdf1bee0523d9e20e2a4d32c65d
parentff43dd75157e74fb37da96656b14264aac4252bd
media: media-entity: Clarify media_entity_cleanup() usage

Being able to call cleanup functions on objects that haven't been
initialized but whose memory has been zeroed simplifies error handling.
The media_entity_cleanup() function documentation doesn't tell whether
this is allowed or not, and inspection of its implementation doesn't
provide any clue as the function is currently empty. Update the
documentation to explicitly allow this usage pattern.

Signed-off-by: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
include/media/media-entity.h