Fix MD034 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/configuration.md:12:15 MD034/no-bare-urls Bare URL used [Context: "https://github.com/openbmc/ope..."

Fix MD034 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/configuration.md:12:15 MD034/no-bare-urls Bare URL used [Context: "https://github.com/openbmc/ope..."]
```
Refer to markdown-lint [1] to fix MD034
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/034-no-bare-urls.md

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

show more ...

Fix MD056 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/oem-extension-numbering.md:118:33 MD056/table-column-count Table column count [Expected: 4; Actual: 3

Fix MD056 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/oem-extension-numbering.md:118:33 MD056/table-column-count Table column count [Expected: 4; Actual: 3; Too few cells, row will be missing data]
docs/oem-extension-numbering.md:121:33 MD056/table-column-count Table column count [Expected: 4; Actual: 3; Too few cells, row will be missing data]
```

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

show more ...

Fix MD001 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/oem-extension-numbering.md:6 MD001/heading-increment Heading levels should only increment by one leve

Fix MD001 warnings

The following warnings are generated by using markdownlint analysis:
```
docs/oem-extension-numbering.md:6 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
```
Refer to markdown-lint [1] to fix MD001
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/001-header-increment.md

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

show more ...

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 ...

Fix MD040 warnings

The following warnings are generated by using markdownlint analysis:
```
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
```
Refer

Fix MD040 warnings

The following warnings are generated by using markdownlint analysis:
```
MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
```
Refer to markdown-lint [1] to fix MD040
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/040-fenced-code-language.md

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

show more ...

Fix MD026 warnings

The following warnings are generated by using markdownlint analysis:
```
MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
MD026/no-trailing-punctua

Fix MD026 warnings

The following warnings are generated by using markdownlint analysis:
```
MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: ':']
MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '.']
```
Refer to markdown-lint [1] to fix MD026
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/026-no-trailing-punctuation.md

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

show more ...

Fix MD041 warnings

The following warnings are generated by using markdownlint analysis:
```
README.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Con

Fix MD041 warnings

The following warnings are generated by using markdownlint analysis:
```
README.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "### Compile ipmid with default..."]
scripts/entity-example.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "If your platform requires the ..."]
docs/ipmi-network-format.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "On platforms running AMI BMC f..."]
```
Refer to markdown-lint [1] to fix MD041
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/041-first-line-h1.md

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

show more ...

Enable reducing the number of sensors managed by IPMI

IPMI is only able to support a finite amount of SDR records. Modern
servers are capable of exceeding the number of sensors the IPMI
specificatio

Enable reducing the number of sensors managed by IPMI

IPMI is only able to support a finite amount of SDR records. Modern
servers are capable of exceeding the number of sensors the IPMI
specification can support.

The change made in this commit filters sensors from a service based
upon contents in a JSON configuration file.

Tested:
Confirmed the default compile resulted in too many sensors being
created.
Added the 'sensor_filter.json' file and confirmed the number of
sensors was reduced, and 'ipmitool sdr list' no longer exhibited error
messages.

Change-Id: I3643e06abbb8708d3f4000f35c79be8901e34057
Signed-off-by: Johnathan Mantey <johnathanx.mantey@intel.com>

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 ...

Fix configuration header

This header did not format correctly due to the space.
https://github.com/openbmc/phosphor-host-ipmid/blob/master/docs/configuration.md

Tested: With https://jbt.github.io/m

Fix configuration header

This header did not format correctly due to the space.
https://github.com/openbmc/phosphor-host-ipmid/blob/master/docs/configuration.md

Tested: With https://jbt.github.io/markdown-editor/

Change-Id: Ief57b88b022844fd74740bb516b9d21f2590e7c3
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

docs: add contributing guidelines

For some time now we the maintainers have been requesting things like
50/72 commit messages, unit tests, Tested: footers, etc. But these
requirements haven't been w

docs: add contributing guidelines

For some time now we the maintainers have been requesting things like
50/72 commit messages, unit tests, Tested: footers, etc. But these
requirements haven't been written down. This document is an attempt to
codify some of the unwritten rules of contribution in the OpenBMC IPMI
stack.

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

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.

Tested: Viewed in C

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
unit testin

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 the .log files

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
to be written in

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 ...

Correct the formatting of the network commands document

The ipmitool commands are placed in the code block.

Change-Id: I787dff9d6acd77ceaa1c6251b4287c2367212cad
Signed-off-by: Tom Joseph <tomjoseph

Correct the formatting of the network commands document

The ipmitool commands are placed in the code block.

Change-Id: I787dff9d6acd77ceaa1c6251b4287c2367212cad
Signed-off-by: Tom Joseph <tomjoseph@in.ibm.com>

show more ...

Docs: Add IPMI command cheatsheet

Adding the network configuration commands

Change-Id: I0542e1266d3bf71c813c3d449bb2838f0dc887cf
Signed-off-by: Ratan Gupta <ratagupt@in.ibm.com>

Grammar and spelling fixes

Spelling errors found using github.com/lucasdemarchi/codespell
A tool to fix common misspellings.
This tool is licensed under GNU General Public License, version 2.
Some a

Grammar and spelling fixes

Spelling errors found using github.com/lucasdemarchi/codespell
A tool to fix common misspellings.
This tool is licensed under GNU General Public License, version 2.
Some additional grammar and capitalization errors were fixed as well.

Change-Id: I700db4e6d7ba52b02374c9c3e84be0af8bd91859
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Get Device ID - JSON

This reads in all the get device ID parameters via a JSON file in the
rootfs.

Using a file in the rootfs will give much more flexibility to consumers
of openbmc. Each ODM can s

Get Device ID - JSON

This reads in all the get device ID parameters via a JSON file in the
rootfs.

Using a file in the rootfs will give much more flexibility to consumers
of openbmc. Each ODM can simply bbappend their dev_id.json with their own
specific get device ID info in. Now you can compile in the required info
at build time, or modify during run time if needed. It also does not
require any additional compilers/scripts to generate a yaml file.

Change-Id: I44dfda54fa1762f88973ad709bf7a50bf32e492d
Signed-off-by: David Cobbley <david.j.cobbley@linux.intel.com>

show more ...

Document OpenBMC OEM Extension Numbering

Includes table of OpenBMC OEM Extension command codes,
and describes message layout of I2C extension.

Change-Id: Idafce7959348fca1e072c0bad09b58bf6c6931ab
S

Document OpenBMC OEM Extension Numbering

Includes table of OpenBMC OEM Extension command codes,
and describes message layout of I2C extension.

Change-Id: Idafce7959348fca1e072c0bad09b58bf6c6931ab
Signed-off-by: Peter Hanson <peterh@google.com>

show more ...

Implement Network Settings Override

We want to implement the network settings override functionality.
This is an OEM boot parameter selector, using parameter ID 0x61.

The first byte of the paramete

Implement Network Settings Override

We want to implement the network settings override functionality.
This is an OEM boot parameter selector, using parameter ID 0x61.

The first byte of the parameter data is the same as parameter ID 5 (ie,
the valid flag in the top bit). Persistency doesn't matter here, as
petitboot will not clear out this setting.

The rest of the parameter data is a host network settings description.
For other BMC firmware, the BMC just treats this as opaque (the BMC will
just return the same data (including that data1 byte), in response to a
Get System Boot Option). For OpenBMC, we may want the BMC to know how to
construct that data; the spec for that is at:

http://ozlabs.org/~sam/ipmi-network-format

Closes openbmc/openbmc#267

Change-Id: I2af8776718deda97acf90d10504783085ccf7323
Signed-off-by: Ratan Gupta <ratagupt@in.ibm.com>

show more ...