X-Git-Url: http://git.madism.org/?a=blobdiff_plain;f=doc%2Fdevel-notes.txt;fp=doc%2Fdevel-notes.txt;h=85b3b7e36cbcd87e9d443ad64c60a047a7e661b6;hb=b1b9961ff1c305dff57f547d28cb509bf007bad7;hp=a40492219685d74d323684559effc5af5e84acb6;hpb=58fbf95737a7601f6e139e39b9f69d102c7e858d;p=apps%2Fmadmutt.git diff --git a/doc/devel-notes.txt b/doc/devel-notes.txt index a404922..85b3b7e 100644 --- a/doc/devel-notes.txt +++ b/doc/devel-notes.txt @@ -101,6 +101,7 @@ Style Guide - try to keep mutt-ng as portable as possible. +- do not use C++-style comments (i.e. "// Comment") Documentation ------------- @@ -117,6 +118,10 @@ where you may have to add documentation: Configuration _variables_ are documented directly in init.h. Note that this includes documentation for possibly added format flags! +When adding variables which depend on system-functionality and/or +./configure switches, you have to add additional availability +information to avoid confusion in the manual. + The parts of The Manual and the muttngrc manual page dealing with these variables, and the global Muttrc, are generated automatically from that documentation. To start this process, type "make