Update plugin documentation
Change-Id: I2ae382699b268b8fc6f33dc0c99b33d281a62528
Signed-off-by: George Keishing <gkeishin@in.ibm.com>
diff --git a/ffdc/docs/plugin.md b/ffdc/docs/plugin.md
index e13aa9a..4c20fd9 100644
--- a/ffdc/docs/plugin.md
+++ b/ffdc/docs/plugin.md
@@ -25,6 +25,7 @@
├── foo_func.py
├── ssh_execution.py
└── telnet_execution.py
+
```
### Plugin Template Example
@@ -49,16 +50,38 @@
### YAML Syntax
+Plugin function without return statement.
```
- plugin:
- plugin_name: plugin.foo_func.print_vars
- plugin_args:
- - "Hello plugin"
+ - "Hello plugin"
+```
+
+Plugin function with return statement.
+```
- plugin:
- -plugin_name: return_value = plugin.foo_func.return_vars
+ - plugin_name: return_value = plugin.foo_func.return_vars
- plugin_args:
```
+when the return directive is used by implying "=" , the `return_value`
+can be accessed within the same block by another following plugins
+by using the variable name directly.
+
+Example:
+```
+ - plugin:
+ - plugin_name: plugin.foo_func.print_vars
+ - plugin_args:
+ - return_value
+```
+
+To accept multiple return values by using coma "," separated statement
+```
+ -plugin_name: return_value1,return_value2 = plugin.foo_func.print_vars
+```
+
### Plugin execution output for sample