Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / docs / ddb9f2ca23209251cd3904fdd6da8125fa72025f
commitddb9f2ca23209251cd3904fdd6da8125fa72025f[log] [tgz]
authorJeremy Kerr <jk@ozlabs.org>Thu Jun 11 09:42:25 2020 +0800
committerJeremy Kerr <jk@ozlabs.org>Thu Jun 11 09:42:25 2020 +0800
tree348786fd7e2dc69b9e4e30783c70189a5ee26d46
parent80b34150d8a3d897158f0e189707f0dc9267c570 [diff]
cpp-style: fix conflicting enum advice

Under the Types section, we have:

  Structs, classes, enums, and typed template parameters should all be
  in UpperCamelCase.

and then in Constants:

  Constants and enums should be named like variables in lowerCamelCase.

It looks like the latter is supposed to refer to enum members, rather
than the enum declaration. This change clarifies the constants section.

Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
Change-Id: I2a96c2901a4840a4dd6b18395353e4054a221900
1 file changed
tree: 348786fd7e2dc69b9e4e30783c70189a5ee26d46
  1. architecture/
  2. code-update/
  3. designs/
  4. development/
  5. logo/
  6. release/
  7. security/
  8. style/
  9. testing/
  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. kernel-development.md
  21. LICENSE
  22. maintainer-workflow.md
  23. MAINTAINERS
  24. Makefile
  25. openbmc-conversion.md
  26. README.md
  27. REDFISH-cheatsheet.md
  28. rest-api.md
  29. REST-cheatsheet.md
  30. subtree.md
  31. 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.