| commit | 44a6f9b8de32218fbe9536cb8bc743b2276bbfb5 | [log] [tgz] |
|---|---|---|
| author | Gunnar Mills <gmills@us.ibm.com> | Fri Sep 07 13:26:10 2018 -0500 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Wed Sep 12 16:08:03 2018 +0000 |
| tree | f35ac2c6b08a6fe228c32aabb8291ede2fed93dd | |
| parent | 4571e0cf10a7cd058f1d02d33f3066b50c2fe794 [diff] |
clang-format: Remove 2nd PointerAlignment PointerAlignment was in the .clang-format example twice. PointerAlignment: Left follows the style defined here: https://github.com/openbmc/docs/blob/master/cpp-style-and-conventions.md#additional-whitespace foo(T& bar, const S* baz); /// Correct. foo(T &bar, const S *baz); /// Incorrect. Also, set DerivePointerAlignment to false so clang-format looks at PointerAlignment instead of "If true, analyze the formatted file for the most common alignment of & and *. Pointer and reference alignment styles are going to be updated according to the preferences found in the file." Change-Id: If33c8842c7e4dc8e03c0ced3a8ba814958daa8a1 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