| commit | e8821cc87221fcb535e436b78c7106ba84164057 | [log] [tgz] |
|---|---|---|
| author | Patrick Williams <patrick@stwcx.xyz> | Sun Oct 02 15:05:02 2022 -0500 |
| committer | Patrick Williams <patrick@stwcx.xyz> | Mon Oct 03 15:42:35 2022 -0500 |
| tree | af228538b9a5152b6cce9bf29abcf49843cabb8f | |
| parent | 991b2b8bdbc950f2a85aebfc29d1b34ea3264686 [diff] |
requirements: add document for known conventions There are some conventions which are not explicitly documented but which have been repeated in code reviews. Add a document to start containing these. Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: I8594015c7deb622d65667f3128babb89bac5ccdd
YAML descriptors of standard D-Bus interfaces. The format is described by the sdbusplus binding generation tool sdbus++.
Before defining a new D-Bus interface or modifying an existing one, please read through the documented set of the common requirements and expectations.
This project can be built with meson. The typical meson workflow is: meson builddir && ninja -C builddir.
The meson files used to handle the YAML files are automatically generated and found under the gen subdirectory. When adding or removing YAML files, this must be regenerated. This can be done with the helper script found in the gen subdirectory: cd gen && ./regenerate-meson.
Only the xyz/openbmc_project and org/freedesktop interfaces are built by default. Other interfaces can be enabled by meson options:
-Ddata_com_ibm=true-Ddata_org_open_power=trueExample: meson builddir -Ddata_com_ibm=true && ninja -C builddir