xref: /openbmc/phosphor-debug-collector/README.md (revision 74a1f39c56d970667b4ff5004ccc175dbe2f23b4)
1# phosphor-debug-collector
2Phosphor Debug Collector provides mechanisms to collect various log files and
3system parameters. Used to troubleshoot problems in OpenBMC based systems.
4
5One such mechanism is [dreport](tools/dreport.d/README.md), a script that
6collects debug data and packages it into an archive file.
7
8## To Build
9To build this package with meson, do the following steps:
10```
11    1. meson builddir
12    2. ninja -C builddir
13```
14To clean the built files run `ninja -C builddir clean`.
15
16## To run unit tests
17Tests can be run in the CI docker container, refer
18[local-ci-build](https://github.com/openbmc/docs/blob/master/testing/local-ci-build.md)
19
20or with an OpenBMC x86 sdk(see below for x86 steps).
21```
22meson -Dtests=enabled build
23ninja -C build test
24```
25