| commit | 45da61966ceecd78c4c56ffa138daa26fa2091d7 | [log] [tgz] |
|---|---|---|
| author | Patrick Williams <patrick@stwcx.xyz> | Wed Jan 25 21:51:29 2017 -0600 |
| committer | Patrick Williams <patrick@stwcx.xyz> | Wed Jan 25 21:54:56 2017 -0600 |
| tree | 8cf3284a484bf7e45bf5e9a62fcc9d62fbc41067 | |
| parent | 0274d9ca981ebf0eeefc678a2da1bdd721b1e4bf [diff] |
cpp-style: Special note on acronyms There was a discussion in code reviews on how acronyms should be handled. In DBus interfaces, we have used UpperCamelCase through-out and therefore acronyms are always UPPERCASE in DBus interfaces specifically. There was an attempt to carry this forward into C++ style, which caused a contradiction between acronyms-always-uppercase and variables-are-lower-case. Clarify this to indicate that acronyms should always be same-case and are UPPER or lower depending on the context. Change-Id: I5bf19595ba38405d1d5d629f8ce854bbc47af8cf 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