1Please read this before making edits to the openbmc base registry.
2
3Messages in this registry are intended to be generally useful across OpenBMC
4systems. To that end, there are a number of guidelines needed for messages in
5this file to remain useful across systems.
6
71. Messages should not be specific to a piece or type of hardware. Generally
8   this involves not using terms like "CPU", "Drive", "Backplane", etc in the
9   message strings, unless that behavior is specific to that particular piece of
10   hardware. Incorrect: MemoryOverheated Correct: DeviceOverheated Correct:
11   MemoryECCError (ECC is specific to memory, therefore class specific is
12   acceptable)
13
142. Messages should not use any proprietary, copyright, or company-specific
15   terms. In general, messages should prefer the industry accepted term.
16
173. Message strings should be human readable, and read like a normal sentence.
18   This generally involves placing the substitution parameters in the
19   appropriate place in the string.
20
21Incorrect: "An error occurred. Device: %1"
22
23Correct: "An error occurred on device %1".
24
254. Message registry versioning semantics shall be obeyed. Adding new messages
26   require an increment to the subminor revision. Changes to existing messages
27   require an increment to the patch version. If the copyright year is different
28   than the current date, increment it when the version is changed.
29
305. If you are changing this in your own downstream company-specific fork, please
31   change the "id" field below away from "OpenBMC.0.X.X" to something of the
32   form of "CompanyName.0.X.X". This is to ensure that when a system is found in
33   industry that has modified this registry, it can be differentiated from the
34   OpenBMC project maintained registry.
35