[PATCH] media: Update documentation for media_entity_notify

From: Shuah Khan
Date: Mon Mar 14 2016 - 18:24:36 EST


Update documentation for media_entity_notify to clearly state the usage
restrictions. This handler is intended for creating links between exiting
entities and should not used to create and register entities.

Signed-off-by: Shuah Khan <shuahkh@xxxxxxxxxxxxxxx>
---
include/media/media-device.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/media/media-device.h b/include/media/media-device.h
index d9867ed..2ca9616 100644
--- a/include/media/media-device.h
+++ b/include/media/media-device.h
@@ -271,8 +271,10 @@ struct device;
* @notify_data: Input data to invoke the callback
* @notify: Callback function pointer
*
- * Drivers may register a callback to take action when
- * new entities get registered with the media device.
+ * Drivers may register a callback to take action when new entities get
+ * registered with the media device. This handler is intended for creating
+ * links between existing entities and should not create entities and register
+ * them.
*/
struct media_entity_notify {
struct list_head list;
--
2.5.0