| commit | 9f34110a08cde80c65b3002e8108d1bff93d309a | [log] [tgz] |
|---|---|---|
| author | Patrick Venture <venture@google.com> | Tue Aug 28 10:29:34 2018 -0700 |
| committer | Patrick Venture <venture@google.com> | Wed Aug 29 09:20:12 2018 -0700 |
| tree | df8b0faa7a2642fe526ce86de61f8bee2beb4d1d | |
| parent | 873a0495132085bb661389c25f1917f4c6cb4b5c [diff] |
add header ordering section to style guide Adds a section to the style guide defining a header inclusion order for header files and source files. Change-Id: Ieb723380bbab257b98b319cda999cf0e9c1ef389 Signed-off-by: Patrick Venture <venture@google.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: 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
kernel-development.md: Reference for common kernel development tasks
REST-cheatsheet.md: Quick reference for some common curl commands usage.
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