| commit | 31f951b3a47735330b7a1fdcae2e9bb6757965d5 | [log] [tgz] |
|---|---|---|
| author | Patrick Williams <patrick@stwcx.xyz> | Mon Nov 07 13:54:52 2016 -0600 |
| committer | Patrick Williams <patrick@stwcx.xyz> | Mon Dec 05 16:46:14 2016 +0000 |
| tree | fa24a638d0698234ea321161b85c7a97019a0f24 | |
| parent | e1712f320914e14f456f3921e7ab0d748c79622d [diff] |
cpp-style: define style guidelines in-depth The original set of C++ style guidelines were arguably insufficient for teams of diverse backgrounds. Attempt to formalize these guidelines and specify in more depth. Change-Id: I22253f7b9de91d693c33d55d612c3555fa5b219f 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