commit | f62262b3fc6ff552b649a7fcf3825d4830ecbedb | [log] [tgz] |
---|---|---|
author | Adriana Kobylak <anoo@us.ibm.com> | Mon Mar 26 12:56:43 2018 -0500 |
committer | Adriana Kobylak <anoo@us.ibm.com> | Tue Apr 10 09:52:23 2018 -0500 |
tree | ac359fe89872867e5710dacdba949592baea53cb | |
parent | f1b07cec5e1b854989a1b07cd05d4b74a9be94e7 [diff] |
cpp-style: Add format-code.sh to clang section With commit https://gerrit.openbmc-project.xyz/#/c/9480/ support for a format-code.sh script is being added to CI. Add it to the documentation for users to take advantage of. Change-Id: I11c56c94c3110a7279db72caf55738d88fc35302 Signed-off-by: Adriana Kobylak <anoo@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