| commit | c7205cb078738c56f432b29e64b28eb31b2ed670 | [log] [tgz] |
|---|---|---|
| author | Brad Bishop <bradleyb@fuzziesquirrel.com> | Tue Feb 05 12:46:00 2019 -0500 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Fri Feb 08 19:06:24 2019 +0000 |
| tree | 792f43e3d0adff3f1c0bee08801d4bf5a530651c | |
| parent | 643c525d4d1340f8844d18c9e1f922669b0b2e9e [diff] |
add anti-paterrns for code review The developers of OpenBMC do not get 100% of decisions right 100% of the time. That, combined with the fact that software development is often an exercise in copying and pasting, results in mistakes happening over and over again. Add a page that aims to document some of the anti-patterns that exist in OpenBMC to ease the job of those reviewing code. If an anti-pattern is spotted, rather that repeating the same explanations over and over, a link to this document can be provided. Change-Id: Ie5efc1ef61a0b948330fa576eca09d5b6fa64751 Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component.
These documents describe how to use OpenBMC, including using the programmatic interfaces to an OpenBMC system.
rest-api.md: Introduction to using the OpenBMC REST API
console.md: Using the host console
host-management.md: Performing host management tasks with OpenBMC
code-update: Updating OpenBMC and host platform firmware
These documents contain details on developing OpenBMC code itself
cheatsheet.md: Quick reference for some common development tasks
CONTRIBUTING.md: Guidelines for contributing to OpenBMC
kernel-development.md: Reference for common kernel development tasks
REST-cheatsheet.md: Quick reference for some common curl commands usage.
The OpenBMC project's aim is to create a highly extensible framework for BMC software and implement for data-center computer systems.
We have a few high-level objectives:
The OpenBMC framework must be extensible, easy to learn, and usable in a variety of programming languages.
Provide a REST API for external management, and allow for "pluggable" interfaces for other types of management interactions.
Provide a remote host console, accessible over the network
Persist network configuration settable from REST interface and host
Provide a robust solution for RTC management, exposed to the host.
Compatible with host firmware implementations for basic IPMI communication between host and BMC
Provide a flexible and hierarchical inventory tracking component
Maintain a sensor database and track thresholds