commit | 124aa0d0d075aafdf5e5b795f75b4eca5d089b5a | [log] [tgz] |
---|---|---|
author | Gunnar Mills <gmills@us.ibm.com> | Wed Jul 05 14:56:02 2017 -0500 |
committer | Gunnar Mills <gmills@us.ibm.com> | Wed Jul 05 14:56:54 2017 -0500 |
tree | 02aac0dea37f4c446aee48f60a0e951d3585fec4 | |
parent | 9461e88002a664d0a35647d6c922abb570b50815 [diff] |
Use correct "D-Bus" spelling in README Change "dbus" to the correct spelling "D-Bus". Change-Id: Ic05a05751b8d79f76d207b17ba736057b68cac6b Signed-off-by: Gunnar Mills <gmills@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 D-Bus
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