Improve example descriptions
These were all labeled: Example Match - improve the
description slightly.
Change-Id: I1ec78c6512fb66423193b5ce0f42b0fc41cdcc45
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
diff --git a/example/events.d/README.md b/example/events.d/README.md
new file mode 100644
index 0000000..336b876
--- /dev/null
+++ b/example/events.d/README.md
@@ -0,0 +1,6 @@
+The files in this directory serve as an illustration of supported
+PIM features and also enable the test suite.
+
+The placement of an event into a file is arbitrary. Multiple files
+are used only to validate that the PIM code generator can handle
+this appropriately.
diff --git a/example/events.d/match1.yaml b/example/events.d/match1.yaml
index 9dca187..afc2974 100644
--- a/example/events.d/match1.yaml
+++ b/example/events.d/match1.yaml
@@ -1,8 +1,9 @@
description: >
- An example inventory match rule.
+ The sample events below serve to illustrate PIM features
+ and are also used by the PIM test suite.
events:
- - name: Example Match
+ - name: setProperty + propertyChangedTo example
description: >
Sets the value of ExampleProperty1 on /changeme
when the value of ExampleProperty2 on
@@ -29,7 +30,7 @@
type: string
value: changed
- - name: Example Match
+ - name: createObjects + propertyChangedTo example
description: >
Create /createme1 and /createme2 when the value of
ExampleProperty2 on /testing/trigger5 changes to abc123.
diff --git a/example/events.d/match2.yaml b/example/events.d/match2.yaml
index a4e98f0..31836b0 100644
--- a/example/events.d/match2.yaml
+++ b/example/events.d/match2.yaml
@@ -1,8 +1,9 @@
description: >
- An example inventory match rule.
+ The sample events below serve to illustrate PIM features
+ and are also used by the PIM test suite.
events:
- - name: Example Match
+ - name: destroyObject + propertyChangedTo example
description: >
Destroys the /deleteme1 and /deleteme2 objects
When the value of ExampleProperty2 on
@@ -26,7 +27,7 @@
- /deleteme1
- /deleteme2
- - name: Example Match
+ - name: destroyObject + propertyChangedTo<int64> example
description: >
Destroys the /deleteme3 object when the value of
ExampleProperty3 on /testing/trigger3
@@ -49,7 +50,7 @@
paths:
- /deleteme3
- - name: Example Match
+ - name: propertyIs example
description: >
Destroys the /deleteme3 object when the value of
ExampleProperty3 on /testing/trigger4 is 99