README.md
1# phosphor-dbus-interfaces
2
3YAML descriptors of standard D-Bus interfaces. The format is described by the
4[sdbusplus binding generation tool sdbus++][].
5
6Before defining a new D-Bus interface or modifying an existing one, please read
7through the documented set of the common [requirements and expectations][].
8
9## Building
10
11This project can be built with `meson`. The typical `meson` workflow is:
12`meson builddir && ninja -C builddir`.
13
14The meson files used to handle the YAML files are automatically generated and
15found under the `gen` subdirectory. When adding or removing YAML files, this
16must be regenerated. This can be done with the helper script found in the `gen`
17subdirectory: `cd gen && ./regenerate-meson`.
18
19## Configuration
20
21Only the xyz/openbmc_project and org/freedesktop interfaces are built by
22default. Other interfaces can be enabled by meson options:
23
24- com/ibm - `-Ddata_com_ibm=true`
25- org/open_power - `-Ddata_org_open_power=true`
26
27Example: `meson builddir -Ddata_com_ibm=true && ninja -C builddir`
28
29## References
30
31[sdbusplus binding generation tool sdbus++]:
32 https://github.com/openbmc/sdbusplus/blob/master/README.md#binding-generation-tool
33[requirements and expectations]: requirements.md
34