Fix MD025 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/testing.md:140 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context

Fix MD025 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/testing.md:140 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# Writing Tests"]
docs/testing.md:427 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# Reviewing Tests"]
docs/testing.md:470 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# Credits"]
docs/configuration.md:25 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# IPMI D-Bus Sensor Filtering"]
```
Refer to markdown-lint [1] to fix MD025
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/025-single-h1.md

Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: I0e59219d9327db7a2589ada84615f9dc345373d5

show more ...

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.

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: I2e1710e269896e36a8bd864cfc81ff3b1c033222
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

docs: add reviewing chapter to testing.md

Cover some best practices while reviewing a test suite, as well as how
to run tests locally without impacting your current environment.

docs: add reviewing chapter to testing.md

Cover some best practices while reviewing a test suite, as well as how
to run tests locally without impacting your current environment.

Tested: Viewed in Chrome

Change-Id: I7356a90fcc9e6d2679e1f9e9a49515a1038a8914
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>

show more ...

doc: add writing test chapter to testing.md

Add a tutorial on writing a new test, based on writing unit tests for
sensorhandler.hpp - specifically GetSdrReq, as it's a good candidate for

doc: add writing test chapter to testing.md

Add a tutorial on writing a new test, based on writing unit tests for
sensorhandler.hpp - specifically GetSdrReq, as it's a good candidate for
unit testing.

Included is a nonexhaustive list of testing best practices. More best
practices are always welcome.

Tested: Viewed testing.md with Chrome builtin Markdown interpreter

Change-Id: I418af8f972a5a0ff36b786cda6fdf9b6b308e8d5
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>

show more ...

docs: add chapter on running tests

Add instructions for installing and setting up Docker, modifying the
setup for phosphor-host-ipmid, and running the tests. This also covers
reading

docs: add chapter on running tests

Add instructions for installing and setting up Docker, modifying the
setup for phosphor-host-ipmid, and running the tests. This also covers
reading the .log files generated during the testing run.

These instructions cover how to use `git worktree` to make a copy of
your working repo which is usable by Docker, but still up-to-date with
the hacking you've been doing. There's also a brief method of coming up
with a similar setup using a local remote or symlink. The worktree
method was selected because it is impossible to make the code you're
testing out-of-sync with the code you will submit to Gerrit for review.
However, we need to mount the working repo to the Docker container too
to make this work (since Git will look there for the .git/ dir).

Tested: Viewed in Chrome

Change-Id: I684664e2580637b34fbb79eceb838986425852c0

show more ...

docs: add initial testing.md outline

Add a new piece of documentation, intended to be a tutorial on running,
writing, and reviewing unit tests for the CI suite. Outline the sections

docs: add initial testing.md outline

Add a new piece of documentation, intended to be a tutorial on running,
writing, and reviewing unit tests for the CI suite. Outline the sections
to be written in some detail (subject to change).

There are a handful of methods for running the CI, foremost by using
Docker or by building the OpenBMC SDK. This tutorial will cover the
Docker method, as it is most similar to what the Jenkins bot does, and
most consistent across platforms.

Tested: Viewed markdown file in Chrome.

Change-Id: Ic98c02bc8f4dc6eaf4e7d1432422cdd934862548

show more ...