diff options
author | Thomas Roessler <roessler@does-not-exist.org> | 1998-06-16 12:00:38 +0000 |
---|---|---|
committer | Thomas Roessler <roessler@does-not-exist.org> | 1998-06-16 12:00:38 +0000 |
commit | c975284b6677110f97719c68b46f7d3d4d415c73 (patch) | |
tree | 39378d0fa34882fe965d0ee42e51794af501d161 | |
parent | f73c27d5974129eb41fd90209e3ca3ad5c016b4d (diff) |
Add a note about the global Muttrc to style-guide.
-rw-r--r-- | doc/style-guide | 31 |
1 files changed, 19 insertions, 12 deletions
diff --git a/doc/style-guide b/doc/style-guide index 1ac44ab6..3bd2b914 100644 --- a/doc/style-guide +++ b/doc/style-guide @@ -1,18 +1,25 @@ Mutt Programming Style Guide ============================ -This information is meant for those of you who are hacking on Mutt and -submitting patches to me. If you follow these guidelines, it will make it -much easier for me to integrate patches. +This information is meant for those of you who are hacking +on Mutt and submitting patches to me. If you follow these +guidelines, it will make it much easier for me to +integrate patches. -- global functions should have the prefix "mutt_". All other functions - should be declared "static". +- global functions should have the prefix "mutt_". All + other functions should be declared "static". -- avoid global vars where possible. If one is required, try to contain it - to a single source file and declare it "static". Global vars should have - the first letter of each word capitilized, and no underscores should be - used (e.g., MailGid, LastFolder, MailDir). +- avoid global vars where possible. If one is required, + try to contain it to a single source file and declare it + "static". Global vars should have the first letter of + each word capitilized, and no underscores should be used + (e.g., MailGid, LastFolder, MailDir). -- re-use code as much as possible. There are a lot of "library" functions. - One of the biggest causes of bloat in ELM and PINE is the tremendous - duplication of code... Help keep Mutt small! +- re-use code as much as possible. There are a lot of + "library" functions. One of the biggest causes of bloat + in ELM and PINE is the tremendous duplication of code... + Help keep Mutt small! + +- when adding new options, make the old behaviour the + default. Please include the new option and it's default + setting with the global Muttrc file. |