Rules for writing GDB documentation
GDB follows the GNU Standards for Documentation.
This page contains additional adhoc rules for writing documentation, either internal (for developers) or external (for users).
Contents
User Documentation
Don't begin a sentence with @var{foo}
It will be italicized, but the sentence will still begin with a lowercase letter. Reword it in some way so that sentence does not begin with a lowercase letter.
ref: https://sourceware.org/ml/gdb-patches/2014-05/msg00618.html
Don't use "path" when you really mean "file name"
This is in the GNU coding standards, but it's not necessarily intuitive, so it's included here.
ref: http://www.gnu.org/prep/standards/standards.html#GNU-Manuals https://sourceware.org/ml/gdb-patches/2015-04/msg00058.html