prettier: re-format
Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.
Change-Id: I89627d0d17fabfd1ea2305d071bfd6247da6b34d
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
diff --git a/README.md b/README.md
index 8d8160a..88bc284 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
# phosphor-debug-collector
+
Phosphor Debug Collector provides mechanisms to collect various log files and
system parameters. Used to troubleshoot problems in OpenBMC based systems.
@@ -6,18 +7,23 @@
collects debug data and packages it into an archive file.
## To Build
+
To build this package with meson, do the following steps:
+
```
1. meson builddir
2. ninja -C builddir
```
+
To clean the built files run `ninja -C builddir clean`.
## To run unit tests
+
Tests can be run in the CI docker container, refer
[local-ci-build](https://github.com/openbmc/docs/blob/master/testing/local-ci-build.md)
or with an OpenBMC x86 sdk(see below for x86 steps).
+
```
meson -Dtests=enabled build
ninja -C build test
diff --git a/example_errors_watch.yaml b/example_errors_watch.yaml
index eb47ec6..cb38153 100644
--- a/example_errors_watch.yaml
+++ b/example_errors_watch.yaml
@@ -1,2 +1,2 @@
-elog:
- - xyz.openbmc_project.Common.Error.InternalFailure
+elog:
+ - xyz.openbmc_project.Common.Error.InternalFailure
diff --git a/tools/dreport.d/README.md b/tools/dreport.d/README.md
index 95890a5..21c573a 100644
--- a/tools/dreport.d/README.md
+++ b/tools/dreport.d/README.md
@@ -4,11 +4,13 @@
information about the system and package it into a tar.xz archive file.
The phosphor-dump-manager application will automatically run dreport in certain
-failure cases, and it can also be run manually by running `dreport` or `dreport
--v`.
+failure cases, and it can also be run manually by running `dreport` or
+`dreport -v`.
## Dump Types
+
The dump types are defined in [sample.conf](sample.conf):
+
- core: Triggered by an application core dump
- user: The type when manually called, such as from running `dreport`.
- elog: Triggered when there are specific phosphor-logging event logs.
@@ -16,9 +18,10 @@
- ramoops: Triggered when there is a kernel panic.
## Plugins
+
The plugins are the shell scripts in the [plugins.d](plugins.d) subdirectory.
They can call [provided functions](include.d/functions) to add data to the dump
-archive. Each plugin needs a comment line like the following to specify which
+archive. Each plugin needs a comment line like the following to specify which
dump types should trigger it:
```
@@ -30,15 +33,17 @@
- 'B' is a priority determines the order the plugins run in.
For example, the `bmcstate` plugin has:
+
```
# config: 12345 5
```
-It will run on dump types 1 (core), 2 (user), 3 (checkstop), 4 (checkstop), and 5
-(ramooops) with a priority of 5.
+It will run on dump types 1 (core), 2 (user), 3 (checkstop), 4 (checkstop), and
+5 (ramooops) with a priority of 5.
During the bitbake build, the script will be linked into a directory based on
the dump type, with the priority built into the name:
+
```
/usr/share/dreport.d# find /usr/share/dreport.d/ -name *bmcstate
/usr/share/dreport.d/plugins.d/bmcstate
diff --git a/xyz/openbmc_project/Dump/Internal/Create.interface.yaml b/xyz/openbmc_project/Dump/Internal/Create.interface.yaml
index 1f4ee4f..e2984c2 100644
--- a/xyz/openbmc_project/Dump/Internal/Create.interface.yaml
+++ b/xyz/openbmc_project/Dump/Internal/Create.interface.yaml
@@ -6,39 +6,39 @@
description: >
Create BMC Dump based on the Dump type.
parameters:
- - name: Type
- type: enum[self.Type]
- description: >
- Type of the Dump.
- - name: FullPaths
- type: array[string]
- description: >
- A list of paths (file paths or d-bus object paths) that must be
- processed to derive the dump content.
+ - name: Type
+ type: enum[self.Type]
+ description: >
+ Type of the Dump.
+ - name: FullPaths
+ type: array[string]
+ description: >
+ A list of paths (file paths or d-bus object paths) that must be
+ processed to derive the dump content.
errors:
- - xyz.openbmc_project.Common.File.Error.Write
- - xyz.openbmc_project.Dump.Create.Error.Disabled
- - xyz.openbmc_project.Dump.Create.Error.QuotaExceeded
+ - xyz.openbmc_project.Common.File.Error.Write
+ - xyz.openbmc_project.Dump.Create.Error.Disabled
+ - xyz.openbmc_project.Dump.Create.Error.QuotaExceeded
enumerations:
- name: Type
description: >
Possible types of BMC Dump.
values:
- - name: ApplicationCored
- description: >
- Dump triggered due to application core.
- - name: UserRequested
- description: >
- Dump triggered by the user.
- - name: InternalFailure
- description: >
- Dump triggered due to InternalFailure type error commit.
- - name: Checkstop
- description: >
- Dump triggered due to Checkstop type error commit.
- - name: Ramoops
- description: >
- Dump triggered due to Ramoops type error commit.
+ - name: ApplicationCored
+ description: >
+ Dump triggered due to application core.
+ - name: UserRequested
+ description: >
+ Dump triggered by the user.
+ - name: InternalFailure
+ description: >
+ Dump triggered due to InternalFailure type error commit.
+ - name: Checkstop
+ description: >
+ Dump triggered due to Checkstop type error commit.
+ - name: Ramoops
+ description: >
+ Dump triggered due to Ramoops type error commit.
# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4