| commit | b410d1a792f16251fba981483a80bed5653d6185 | [log] [tgz] |
|---|---|---|
| author | Patrick Venture <venture@google.com> | Tue Mar 12 16:01:25 2019 -0700 |
| committer | Gunnar Mills <gmills@us.ibm.com> | Mon Mar 18 16:50:39 2019 +0000 |
| tree | c2cd4b987c1a840cbee0fb5226a7481d58680302 | |
| parent | eb9d9b47a11ddc0b29c909844f20b4e83b6e33e3 [diff] |
anti-patterns: use cli11 instead of custom parser Many OpenBMC applications have a custom ArgumentParser object to provide a modern argument parsing interface. These are nearly identical between daemons. The CLI11 library provides a modern argument parsing interface with advanced validation. Change-Id: I11ca97b2990e342c203ec54b9f3d40bbcebb55eb Signed-off-by: Patrick Venture <venture@google.com>
This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component.
The features document lists the project's major features with links to more information.
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