commit | 1dc181c44fddcaa4d644a4c7ec99662f4257140d | [log] [tgz] |
---|---|---|
author | Andrew Geissler <geissonator@yahoo.com> | Wed Sep 19 17:00:33 2018 -0500 |
committer | Gunnar Mills <gmills@us.ibm.com> | Wed Oct 03 14:27:07 2018 +0000 |
tree | 1bb6895c335f49ffa37145167310c261b91233e5 | |
parent | cbdddfc9423d5dd30b48a6fa3b17f7d76e82a5f8 [diff] |
dev-doc: development environment setup document A document new developers to OpenBMC can reference for setting up a basic development environment to test their code against. Change-Id: I31180217a9a5e5bb89bf533b123979ba0db182a5 Signed-off-by: Andrew Geissler <geissonator@yahoo.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