Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / docs / 9746aeb8ea2c73bb4802197406aa8342ffd1138f
commit9746aeb8ea2c73bb4802197406aa8342ffd1138f[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Fri Apr 22 09:46:33 2022 -0400
committerPatrick Williams <patrick@stwcx.xyz>Fri Apr 22 15:13:20 2022 +0000
treeb1903cfdb0647310509a65fb81d8ee0de8587e0c
parent1f45b3001f01e56226f74f6e1f272ff4adc70874 [diff]
Make layer-guidelines a real markdown document

Add headers/anchors.  This facilitates easy copy & paste of links to
specific sections of the document.  Remove periods from new headers
because markdownlint doesn't allow that.  Reword the EXTRA_OEMAKE
guideline so it fits on a single line.

Add bolding and linebreaks around **why?** and **What should I do
instead?**.  The intent seems to have been to have these render on their
own line (bold and not H3 because markdownlint does not allow multiple
headings with the same content).

Add linebreaks in other places where the intent was for a new paragraph
to be rendered(I think?).

Change {autorev} to make it look more like it actually appears in the
code.

Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
Change-Id: Ib49d9e1079ff3a8b27c788ae34e1868a01cffc8f
1 file changed
tree: b1903cfdb0647310509a65fb81d8ee0de8587e0c
  1. architecture/
  2. designs/
  3. development/
  4. logo/
  5. release/
  6. security/
  7. style/
  8. testing/
  9. tof/
  10. userguide/
  11. anti-patterns.md
  12. cheatsheet.md
  13. code-of-conduct.md
  14. console.md
  15. CONTRIBUTING.md
  16. cpp-style-and-conventions.md
  17. features.md
  18. glossary.md
  19. host-management.md
  20. IPMITOOL-cheatsheet.md
  21. kernel-development.md
  22. LICENSE
  23. maintainer-workflow.md
  24. MAINTAINERS
  25. Makefile
  26. meta-layer-guidelines.md
  27. openbmc-conversion.md
  28. OWNERS
  29. README.md
  30. REDFISH-cheatsheet.md
  31. rest-api.md
  32. REST-cheatsheet.md
  33. SECURITY.md
  34. subtree.md
  35. yocto-development.md
README.md

OpenBMC documentation

The OpenBMC project is a Linux Foundation project whose goal is to produce a customizable, open-source firmware stack for Baseboard Management Controllers (BMCs). 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.

Contact

OpenBMC Development

These documents contain details on developing OpenBMC code itself

OpenBMC Usage

These documents describe how to use OpenBMC, including using the programmatic interfaces to an OpenBMC system.