wiki:LogMessagesStyleGuide

This wiki page provides guidelines for writing and editing log messages (.mes) files. These files contain the unique logging keywords, brief one line descriptions, and longer detailed explanation. This is documented in detail in the source tree at src/lib/log/README. The generated HTML Log Messages file is at http://bind10.isc.org/docs/bind10-messages.html.

  • Spell out "BIND 10" with a space.
  • The brief message starts with lowercase (unless word or acronym is always started with uppercase).
  • The brief message does not end with a period.
  • The explanations should be complete sentences with proper punctuation (including trailing period).
  • If the explanation says it is a developer error, also tell user to report it as a bug.
  • Use US English spelling instead of British English.
Last modified 6 years ago Last modified on Jul 6, 2011, 2:35:07 PM