phosphor-host-ipmid/docs, branch master

Fix configuration header

2019-10-29T16:58:00+00:00

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

docs: add contributing guidelines

2019-10-17T10:31:23+00:00

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 Change-Id: Ieb7a72f89f44374efbbe7265c7341338f6850158

docs: add reviewing chapter to testing.md

2019-06-26T01:36:05+00:00

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

doc: add writing test chapter to testing.md

2019-06-26T01:35:59+00:00

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

docs: add chapter on running tests

2019-06-26T01:05:14+00:00

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

docs: add initial testing.md outline

2019-06-26T01:04:27+00:00

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

Correct the formatting of the network commands document

2018-07-24T20:53:51+00:00

The ipmitool commands are placed in the code block. Change-Id: I787dff9d6acd77ceaa1c6251b4287c2367212cad Signed-off-by: Tom Joseph

Docs: Add IPMI command cheatsheet

2018-07-17T17:24:22+00:00

Adding the network configuration commands Change-Id: I0542e1266d3bf71c813c3d449bb2838f0dc887cf Signed-off-by: Ratan Gupta

Grammar and spelling fixes

2018-04-18T21:56:36+00:00

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

Get Device ID - JSON

2018-01-04T23:27:45+00:00

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