commit | 9235d959e5ca9501123369696ab1a6c0ccbda5bb | [log] [tgz] |
---|---|---|
author | Milton Miller <miltonm@us.ibm.com> | Mon Jul 11 15:32:08 2016 -0500 |
committer | Milton Miller <miltonm@us.ibm.com> | Mon Jul 11 15:32:08 2016 -0500 |
tree | 37b1fe80e75a2fab73c4836ab731bf5d32689347 | |
parent | cfd9d114184e1f441298d49735e3384094aa3b0c [diff] |
Clean up formatting When reviewing the formatted output I discovered my receint additions to the dbus interfaces did not have trailing periods. In addition one of the entries did not parse the bold formatting. I tracked the later down to a space between the text and the intended end bold. I also added a few columns to headers where the text was longer than the initial columns. This makes the file a bit easier to read when viewing the markdown as plain text. Signed-off-by: Milton Miller <miltonm@us.ibm.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.md: 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
dbus-interfaces.md: Reference for APIs exposed to dbus
kernel-development.md: Reference for common kernel development tasks
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