openbmc/entity-manager/CONFIG_FORMAT.md

13    - Configuration files will get replicated and built to support hundreds of
19    - Reactor writers tend to be domain experts on their subsystem, and
30    - Hardware constraints, bugs, and oddities are generally found over time. The
35    - Having separate config files reduces the number of platforms that need to
39    - Having one config file per piece of hardware makes it much easier and clear
41    - Note: This is a "guideline" not a "rule". There are many cases of hardware
44      - Example: SAS modules and cards made by the same company, on the same
46      - Non-Example: Power supplies. While all pmbus power supplies appear
51 3. Configuration files are not a long-term stable ABI. Why?
53    - Configuration files occasionally need to modify their schema in pursuit of
56    - The repo will ensure that all schema changes are enacted such that the
60    - Note: This drives the requirement that config files shall not be checked
61      into OpenBMC meta layers.
65    - There are many behaviors that the BMC has that are very easily detected at
69      platforms, and doesn't need to be an entity-configurable parameter. In
78 boards) such as baseboard, risers, and hot-swap backplanes. While it is
90 …------------ | ------------------------------------------------------------------- | -------------…
92 …'BOARD_PRODUCT_NAME':'FFPANEL'})"` | Statement which attempts to read from d-bus. The result deter…
102 …-------------- | :--------------------------------------------------------------------------------…
104 …n the "probe" is successful, this template string is substituted with the (7-bit) I2C address of t…
105 | "$index"        | A run-tim enumeration. This template string is substituted with a unique index …
116 ## Configuration Records - Baseboard Example
211 [Full Configuration](https://github.com/openbmc/entity-manager/blob/master/configurations/WFT_Baseb…
213 ## Configuration Records - Chassis Example
254 The entity-manager can key off of different types and export devices for
258 ## C-Style Comments Support
260 The configuration JSON file supports c-style comments base on the rules as
263 - Single-line style comments (//) can be on a new line or at the end of a line
268   // Single-line style comment (new line)
269   Key: "Value", // Single-line comment (end of content)
273 - Multi-line style comments (/\* \*/) use the must be free-standing.
277   /* Multi-line style comment */
279    * Multi-line style comments
284 - When running autojson.py on a configuration JSON file, the comments will be
289 - No attempts to re-indent multi-line comments will be made.
292 prettier before using this script and planning to move multi-line comments