diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 49 |
1 files changed, 43 insertions, 6 deletions
@@ -1,10 +1,47 @@ -## To Build +Phosphor Inventory Manager (PIM) is an implementation of the +xyz.openbmc_project.Inventory.Manager DBus interface, and supporting tools. +PIM uses a combination of build-time YAML files and run-time calls to the +Notify method of the Manager interface to provide a generalized inventory +state management solution. + +## YAML +PIM includes a YAML parser (pimgen.py). For PIM to do anything useful, a +set of YAML files must be provided externally that tell it what to do. +An example can be found in the examples directory. + +The following top level YAML tags are supported: + +* description - An optional description of the file. +* events - One or more events that PIM should monitor. + +---- +**events** +Supported event tags are: + +* name - A globally unique event name. +* type - The event type. Supported types are: *match*. + +Subsequent tags are defined by the event type. + +---- +**match** +Supported match tags are: + +* signature - A DBus match specification. + +---- + +## Building +After running pimgen.py, build PIM using the following steps: + +``` + ./bootstrap.sh + ./configure ${CONFIGURE_FLAGS} + make ``` -To build this package, do the following steps: - 1. ./bootstrap.sh - 2. ./configure ${CONFIGURE_FLAGS} - 3. make +To clean the repository run: -To full clean the repository again run `./bootstrap.sh clean`. +``` + ./bootstrap.sh clean ``` |
