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).

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.


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.


None: Internals GDB-Doc-Standards (last edited 2015-04-09 07:10:37 by DougEvans)

All content (C) 2008 Free Software Foundation. For terms of use, redistribution, and modification, please see the WikiLicense page.