1*1a0866caSEd Tanous# Registry Edits: Read me first 2*1a0866caSEd Tanous 33e5faba5SEd TanousPlease read this before making edits to the openbmc base registry. 43e5faba5SEd Tanous 53e5faba5SEd TanousMessages in this registry are intended to be generally useful across OpenBMC 63e5faba5SEd Tanoussystems. To that end, there are a number of guidelines needed for messages in 73e5faba5SEd Tanousthis file to remain useful across systems. 83e5faba5SEd Tanous 93e5faba5SEd Tanous1. Messages should not be specific to a piece or type of hardware. Generally 103e5faba5SEd Tanous this involves not using terms like "CPU", "Drive", "Backplane", etc in the 113e5faba5SEd Tanous message strings, unless that behavior is specific to that particular piece of 123e5faba5SEd Tanous hardware. Incorrect: MemoryOverheated Correct: DeviceOverheated Correct: 133e5faba5SEd Tanous MemoryECCError (ECC is specific to memory, therefore class specific is 143e5faba5SEd Tanous acceptable) 153e5faba5SEd Tanous 163e5faba5SEd Tanous2. Messages should not use any proprietary, copyright, or company-specific 173e5faba5SEd Tanous terms. In general, messages should prefer the industry accepted term. 183e5faba5SEd Tanous 193e5faba5SEd Tanous3. Message strings should be human readable, and read like a normal sentence. 203e5faba5SEd Tanous This generally involves placing the substitution parameters in the 21*1a0866caSEd Tanous appropriate place in the string. Incorrect: "An error occurred. Device: %1" 223e5faba5SEd Tanous Correct: "An error occurred on device %1". 233e5faba5SEd Tanous 243e5faba5SEd Tanous4. Message registry versioning semantics shall be obeyed. Adding new messages 253e5faba5SEd Tanous require an increment to the subminor revision. Changes to existing messages 263e5faba5SEd Tanous require an increment to the patch version. If the copyright year is different 273e5faba5SEd Tanous than the current date, increment it when the version is changed. 283e5faba5SEd Tanous 293e5faba5SEd Tanous5. If you are changing this in your own downstream company-specific fork, please 303e5faba5SEd Tanous change the "id" field below away from "OpenBMC.0.X.X" to something of the 313e5faba5SEd Tanous form of "CompanyName.0.X.X". This is to ensure that when a system is found in 323e5faba5SEd Tanous industry that has modified this registry, it can be differentiated from the 333e5faba5SEd Tanous OpenBMC project maintained registry. 34