| commit | 4f7b4b6dc4ad6e0ffb9d354288eb2f60f0bd6863 | [log] [tgz] |
|---|---|---|
| author | Gunnar Mills <gmills@us.ibm.com> | Fri Sep 21 14:01:15 2018 -0500 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Fri Sep 21 14:12:46 2018 -0500 |
| tree | 421c88e5f23948a7ca9e3965ff2838d0ab2f77f9 | |
| parent | 9ec2013bac2122ce8926b651901f589d84984ffb [diff] |
cpp-style-and-conventions.md: Remove astyle The astyle command listed formatted the code in a way that varied quite a bit from our coding style. Leaving this command could confuse users into thinking they could use astyle for C++ code. With clang-format being enforced by CI, best to remove astyle and stick with clang-format. Change-Id: I5f80048e037fc2768f07702ade22031a802a002a 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: 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