Name
Date
Size
#Lines
LOC

..--

architecture/H--4,5873,613

designs/H--20,37715,888

development/H--1,5771,203

logo/H--5048

process/H--274213

release/metrics/H--16,62815,655

security/H--1,132858

style/H--288277

testing/H--284210

tof/H--250193

userguide/H--3526

.markdownlint.yamlH A D12-Dec-202245 43

.prettierrc.yamlH A D12-Dec-2022115 87

CONTRIBUTING.mdH A D16-Jan-202419.2 KiB481337

IPMITOOL-cheatsheet.mdH A D08-Dec-20229.3 KiB368250

LICENSEH A D24-Oct-201818.2 KiB397305

MakefileH A D24-Jun-2020477 2412

OWNERSH A D21-Feb-20242.2 KiB7469

README.mdH A D08-Dec-20221.7 KiB5334

REDFISH-cheatsheet.mdH A D21-Aug-20246.5 KiB217141

REST-cheatsheet.mdH A D08-Mar-202310.8 KiB281193

SECURITY.mdH A D02-Dec-20242.4 KiB6047

anti-patterns.mdH A D17-Jan-202423.5 KiB627447

cheatsheet.mdH A D08-Dec-202211.8 KiB403295

code-of-conduct.mdH A D08-Dec-20229.3 KiB210160

community-membership.mdH A D02-Dec-202413.9 KiB286225

console.mdH A D08-Dec-20221.2 KiB4426

cpp-style-and-conventions.mdH A D12-Jul-202312.3 KiB458338

discord-rules.mdH A D26-Nov-20231.6 KiB3123

features.mdH A D02-Dec-20244.6 KiB10094

glossary.mdH A D08-Dec-20221.5 KiB4127

host-management.mdH A D08-Dec-202212.5 KiB323237

hw-vendor-repos-policy.mdH A D13-May-20248 KiB184133

kernel-development.mdH A D08-Dec-20225.3 KiB142104

maintainer-workflow.mdH A D08-Dec-20222.2 KiB5039

meta-layer-guidelines.mdH A D08-Dec-20226.9 KiB158114

openbmc-conversion.mdH A D08-Dec-2022747 1915

rest-api.mdH A D08-Mar-202312.8 KiB409331

subtree.mdH A D08-Dec-2022349 86

yocto-development.mdH A D08-Dec-20224.4 KiB12190

README.md

1# OpenBMC documentation
2
3The [OpenBMC project](https://www.openbmc.org/) is a Linux Foundation project
4whose goal is to produce a customizable, open-source firmware stack for
5Baseboard Management Controllers (BMCs). This repository contains documentation
6for OpenBMC as a whole. There may be component-specific documentation in the
7repository for each component.
8
9The [features](features.md) document lists the project's major features with
10links to more information.
11
12## Contact
13
14- Mail: openbmc@lists.ozlabs.org https://lists.ozlabs.org/listinfo/openbmc
15- List Archive: https://lore.kernel.org/openbmc/
16- Discord: https://discord.gg/69Km47zH98
17
18## OpenBMC Development
19
20These documents contain details on developing OpenBMC code itself
21
22- [cheatsheet.md](cheatsheet.md): Quick reference for some common development
23  tasks
24
25- [CONTRIBUTING.md](CONTRIBUTING.md): Guidelines for contributing to OpenBMC
26
27- [development tutorials](development/README.md): Tutorials for getting up to
28  speed on OpenBMC development
29
30- [kernel-development.md](kernel-development.md): Reference for common kernel
31  development tasks
32
33## OpenBMC Usage
34
35These documents describe how to use OpenBMC, including using the programmatic
36interfaces to an OpenBMC system.
37
38- [code-update](architecture/code-update): Updating OpenBMC and host platform
39  firmware
40
41- [console.md](console.md): Using the host console
42
43- [host-management.md](host-management.md): Performing host management tasks
44  with OpenBMC
45
46- [rest-api.md](rest-api.md): Introduction to using the OpenBMC REST API
47
48- [REDFISH-cheatsheet.md](REDFISH-cheatsheet.md): Quick reference for some
49  common OpenBMC Redfish commands
50
51- [REST-cheatsheet.md](REST-cheatsheet.md): Quick reference for some common
52  OpenBMC REST API commands
53