Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-debug-collector / 0cfe1a2ee0fd9ecf69d340f7bad4a2a9c1b04d32
commit0cfe1a2ee0fd9ecf69d340f7bad4a2a9c1b04d32[log] [tgz]
authorDhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>Wed Jun 21 14:16:22 2023 -0500
committerDhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>Wed Jun 21 14:37:18 2023 -0500
tree9ca8dfe8b869a0d691ee8da2ba943271921b346d
parentd73a663c79943ae97194347ca1ee3f8d454f6bfa [diff]
Fix markdownlint and shellcheck errors

This commit addresses issues with markdownlint complaining
about unspecified languages for the fenced code blocks in
the README.md files of the main repo and the dreport tool.

Resolved this by specifying 'bash' as the language for
these code blocks in both README.md files.

Additionally added tools/dreport.d/ibm.d/plugins.d/badpel
to .shellcheck-ignore to suppress SC1091 and SC2086
errors

Change-Id: I3432dc87999f518949a9459d2ab07e21a73595b1
Signed-off-by: Dhruvaraj Subhashchandran <dhruvaraj@in.ibm.com>
4 files changed
tree: 9ca8dfe8b869a0d691ee8da2ba943271921b346d
  1. dump-extensions/
  2. host-transport-extensions/
  3. subprojects/
  4. test/
  5. tools/
  6. xyz/
  7. .clang-format
  8. .gitignore
  9. .shellcheck-ignore
  10. bmc_dump_entry.cpp
  11. bmc_dump_entry.hpp
  12. core_manager.cpp
  13. core_manager.hpp
  14. core_manager_main.cpp
  15. dump-extensions.hpp
  16. dump_entry.cpp
  17. dump_entry.hpp
  18. dump_internal.hpp
  19. dump_manager.cpp
  20. dump_manager.hpp
  21. dump_manager_bmc.cpp
  22. dump_manager_bmc.hpp
  23. dump_manager_faultlog.cpp
  24. dump_manager_faultlog.hpp
  25. dump_manager_main.cpp
  26. dump_offload.cpp
  27. dump_offload.hpp
  28. dump_serialize.cpp
  29. dump_serialize.hpp
  30. dump_utils.cpp
  31. dump_utils.hpp
  32. elog_watch.cpp
  33. elog_watch.hpp
  34. errors_map.mako.hpp
  35. errors_map_gen.py
  36. example_errors_watch.yaml
  37. faultlog_dump_entry.cpp
  38. faultlog_dump_entry.hpp
  39. ffdc
  40. host_transport_exts.hpp
  41. LICENSE
  42. meson.build
  43. meson_options.txt
  44. OWNERS
  45. ramoops_manager.cpp
  46. ramoops_manager.hpp
  47. ramoops_manager_main.cpp
  48. README.md
  49. watch.cpp
  50. watch.hpp
README.md

phosphor-debug-collector

Phosphor Debug Collector provides mechanisms to collect various log files and system parameters. Used to troubleshoot problems in OpenBMC based systems.

One such mechanism is dreport, a script that 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

or with an OpenBMC x86 sdk(see below for x86 steps).

meson -Dtests=enabled build
ninja -C build test