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