diff options
| author | Abhishek Pandit <abhishekpandit@google.com> | 2016-11-10 13:21:45 -0800 |
|---|---|---|
| committer | Abhishek Pandit <abhishekpandit@google.com> | 2016-11-18 10:11:32 -0800 |
| commit | c5b45f164c31d96f6ba4aef61d597e0a6e9866ad (patch) | |
| tree | 4d72aa6aff202be4b9c5c33de9d0ecc79840c7bf | |
| parent | 3f56596af9f7db4e76c13ee52a5ec42c976ee52a (diff) | |
| download | sdbusplus-c5b45f164c31d96f6ba4aef61d597e0a6e9866ad.tar.gz sdbusplus-c5b45f164c31d96f6ba4aef61d597e0a6e9866ad.zip | |
Added readme with instructions on how to use sdbus++
Added instructions for using sdbus++.
Change-Id: Ibdd89f6971e05f16797ee04a2eeb1c4fc6a8676b
Signed-off-by: Abhishek Pandit <abhishekpandit@google.com>
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..d232426 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# sdbusplus + +sdbusplus is a library and a tool for generating C++ bindings to dbus. + +## How to use tools/sdbus++ + +The path of your file will be the interface name. For example, for an interface +`xyz.openbmc_project.control.Chassis`, you would create the following file: +`xyz/openbmc_project/control/Chassis.interface.yaml`. Similary, for errors, you +would create `xyz/openbmc_project/control/Chassis.errors.yaml`. + +Generating all the files: +``` +root_dir=$(readlink -f ../phosphor-dbus-interfaces) +desired_interface=xyz.openbmc_project.control.Chassis +file_prefix=chassis_interface +file_exp_prefix=chassis_interface_exceptions +outdir=../phosphor-chassis-control/generated + +# Server bindings +python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir interface server-header $desired_interface > $outdir/$file_prefix.hpp +python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir interface server-cpp $desired_interface > $outdir/$file_prefix.cpp + +# Exception bindings +python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir error exception-header $desired_interface > $outdir/$file_exp_prefix.hpp +python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir error exception-cpp $desired_interface > $outdir/$file_exp_prefix.cpp + +# Docs +python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir interface markdown $desired_interface > $outdir/$file_prefix.md +python tools/sdbus++ --templatedir=tools/sdbusplus/templates --rootdir=$root_dir error markdown $desired_interface > $outdir/$file_exp_prefix.md +``` |
