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