| commit | f1b07cec5e1b854989a1b07cd05d4b74a9be94e7 | [log] [tgz] |
|---|---|---|
| author | Gunnar Mills <gmills@us.ibm.com> | Sun Apr 08 17:54:55 2018 -0500 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Tue Apr 10 14:01:22 2018 +0000 |
| tree | d950b67460040322fa3761301b5ede549587abfb | |
| parent | f14504e4708531c31da6c6edb608ecf5f537b9b2 [diff] |
Move Python Formatting to contributing.md Moved the Python Formatting section from cpp-style-and-conventions to contributing. cpp-style-and-conventions is meant for C++ code only. Change-Id: I23b1fcd5dd9a98a2e1085501a476b24556461031 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