Changes between Version 2 and Version 3 of CodingStyle


Ignore:
Timestamp:
Oct 21, 2013 10:26:19 PM (4 years ago)
Author:
MichaelRay
Comment:

minor fixes

Legend:

Unmodified
Added
Removed
Modified
  • CodingStyle

    v2 v3  
    55 * avoid global vars where possible.
    66  * If one is required, try to contain it to a single source file and declare it "static".
    7   * Global vars should have the first letter of each word capitilized, and no underscores should be used (e.g., MailGid, LastFolder, MailDir).
     7  * Global vars should have the first letter of each word capitalized, and no underscores should be used (e.g., MailGid, LastFolder, MailDir).
    88 * re-use code as much as possible. There are many "library" functions. A major cause of bloat in ELM and PINE is the tremendous duplication of code... Help keep Mutt small!
    9  * when adding new options, make the old behaviour the default.
     9 * when adding new options, make the old behavior the default.
    1010 * try to keep mutt as portable as possible.
    1111
     
    3434Please document your changes.  Note that there are several places where you may have to add documentation:
    3535 * doc/manual.xml.{head,tail} contain The Manual.
    36  * doc/muttrc.man.{head,tail} contain an abriged version of The Manual in nroff format (see man(7)), which deals with configuration file commands.
     36 * doc/muttrc.man.{head,tail} contain an abridged version of The Manual in nroff format (see man(7)), which deals with configuration file commands.
    3737
    3838Configuration '''variables''' are documented directly in `init.h`.   Note that this includes documentation for possibly added format flags!
     
    5656 * \fP switches to normal display
    5757 * \(as can be used to represent an asterisk (*).  This is intended to help avoiding character sequences such as /* or */ inside comments.
    58  * \(rs can be used to represent a backslash (\).  This is intended to help avoiding poblems when trying to represent any of the \ sequences used by makedoc.
     58 * \(rs can be used to represent a backslash (\).  This is intended to help avoiding problems when trying to represent any of the \ sequences used by makedoc.
    5959 * .dl on a line starts a "definition list" environment (name taken from HTML) where terms and definitions alternate.
    6060 * .dt marks a term in a definition list.