commit | 9af10b2aebccb47f5095e5ed5c3c887e309ff02c | [log] [tgz] |
---|---|---|
author | Xo Wang <xow@google.com> | Tue Jan 16 18:08:17 2018 -0800 |
committer | Gunnar Mills <gmills@us.ibm.com> | Mon Feb 12 17:14:06 2018 +0000 |
tree | d2ca6ed3dd6ddb06075703ef25141a6053f45ad2 | |
parent | 325f4358872e0d33f06e1d98ab7d8b1b2405d7d4 [diff] |
contributing: Add testing expectation, commit message requirement Tested: Documentation change; no code affected. Signed-off-by: Xo Wang <xow@google.com> Change-Id: Ie7064b1aea31906b59c2672f6ded9509a62b8a17
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