README formatting update.
Change filter/action identifier from name to type for consistancy.
Minor formatting tweaks.
Change-Id: If4e34ac7b9b76b12e4bd6b72c49cd324c229e32f
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
diff --git a/README.md b/README.md
index 5cdb260..2efecfb 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,7 @@
----
**events**
+
Supported event tags are:
* name - A globally unique event name.
@@ -26,12 +27,13 @@
----
**action**
+
Supported action tags are:
-* name - The action name.
+* type - The action to perform.
* args - An optional list of arguments to pass to the action.
-* value - The argument value.
-* type - The argument type (defaults to string if unspecified).
+ * value - The argument value.
+ * type - The argument type (defaults to string if unspecified).
The available actions provided by PIM are:
@@ -40,6 +42,7 @@
----
**match**
+
Supported match tags are:
* signature - A DBus match specification.
@@ -47,12 +50,13 @@
----
**filter**
+
Supported filter tags are:
-* name - The name of the filter.
+* type - The filter to use.
* args - An optional list of arguments to pass to the filter.
-* value - The argument value.
-* type - The argument type (defaults to string if unspecified).
+ * value - The argument value.
+ * type - The argument type (defaults to string if unspecified).
The available filters provided by PIM are:
diff --git a/examples/match1.yaml b/examples/match1.yaml
index 87e5148..00b401f 100644
--- a/examples/match1.yaml
+++ b/examples/match1.yaml
@@ -11,6 +11,6 @@
interface: org.freedesktop.DBus.Properties
member: PropertiesChanged
action:
- name: noop
+ type: noop
# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
diff --git a/examples/match2.yaml b/examples/match2.yaml
index 269a469..db10099 100644
--- a/examples/match2.yaml
+++ b/examples/match2.yaml
@@ -13,12 +13,12 @@
interface: org.freedesktop.DBus.Properties
member: PropertiesChanged
filter:
- name: propertyChangedTo
+ type: propertyChangedTo
args:
- value: xyz.openbmc_project.Testing
- value: TestProperty
- value: teststring
action:
- name: destroyObject("Example")
+ type: destroyObject("Example")
# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
diff --git a/pimgen.py b/pimgen.py
index 37819d3..2b6e7ad 100755
--- a/pimgen.py
+++ b/pimgen.py
@@ -78,7 +78,7 @@
if fltr is None:
self.name = self.default
else:
- self.name = fltr.get('name')
+ self.name = fltr.get('type')
self.args = fltr.get('args')
def __call__(self, fd):