]> granicus.if.org Git - mutt/commitdiff
Add a note about the global Muttrc to style-guide.
authorThomas Roessler <roessler@does-not-exist.org>
Tue, 16 Jun 1998 12:00:38 +0000 (12:00 +0000)
committerThomas Roessler <roessler@does-not-exist.org>
Tue, 16 Jun 1998 12:00:38 +0000 (12:00 +0000)
doc/style-guide

index 1ac44ab62e1b56f960862bd633175d9058e0b44a..3bd2b91476443f274046ad569b2947f3537752f1 100644 (file)
@@ -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.