| commit | 017f58c133a26de158c7adb758d01b64172929c4 | [log] [tgz] |
|---|---|---|
| author | Patrick Williams <patrick@stwcx.xyz> | Wed Jul 20 17:25:53 2016 -0500 |
| committer | Patrick Williams <patrick@stwcx.xyz> | Wed Jul 20 17:28:57 2016 -0500 |
| tree | b24f46baaf34e02e8296a7ac4a03e6bc4b344b2f | |
| parent | 2e8a2141f87d49510faf012cea7a17a2839e02bf [diff] |
contributing: Add style for C++ Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
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