diff mbox series

handlers: document handler masks

Message ID 20171006105845.32226-1-christian.storm@siemens.com
State Accepted
Headers show
Series handlers: document handler masks | expand

Commit Message

Storm, Christian Oct. 6, 2017, 10:58 a.m. UTC 
Signed-off-by: Christian Storm <christian.storm@siemens.com>
---
 doc/source/handlers.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc/source/handlers.rst b/doc/source/handlers.rst
index f2bc9ad..51e087f 100644
--- a/doc/source/handlers.rst
+++ b/doc/source/handlers.rst
@@ -78,7 +78,7 @@  The handler's developer registers his own handler with a call to:
 	__attribute__((constructor))
 	void my_handler_init(void)
 	{
-		register_handler("mytype", my_handler, data);
+		register_handler("mytype", my_handler, my_mask, data);
 	}
 
 SWUpdate uses the gcc constructors, and all supplied handlers are registered
@@ -88,12 +88,14 @@  register_handler has the syntax:
 
 ::
 
-	register_handler(my_image_type, my_handler, data);
+	register_handler(my_image_type, my_handler, my_mask, data);
 
 Where:
 
 - my_image_type : string identifying the own new image type.
 - my_handler : pointer to the installer to be registered.
+- my_mask : ``HANDLER_MASK`` enum value(s) specifying what
+  input type(s) my_handler can process.
 - data : an optional pointer to an own structure, that SWUpdate
   saves in the handlers' list and pass to the handler when it will
   be executed.