X-Git-Url: http://git.madism.org/?a=blobdiff_plain;f=doc%2Fdevel-notes.txt;h=f6455f6ded95180a88210d725b2283ed74356547;hb=0ac011f8eb41bab7808881ebf9802b4eb252fe3b;hp=51b4212ed214b74516985eed2e08a433fcfddb85;hpb=2b6a8b2b48fc8427a9d0df8222b61ccdeb9e9ae2;p=apps%2Fmadmutt.git diff --git a/doc/devel-notes.txt b/doc/devel-notes.txt index 51b4212..f6455f6 100644 --- a/doc/devel-notes.txt +++ b/doc/devel-notes.txt @@ -57,7 +57,7 @@ Getting started from SVN Once you've checked out a copy of the source from SVN from svn.berlios.de/svnroot/repos/mutt-ng , you'll need to run the script -called 'prepare' that is in the root directory. The script does all the +called 'autogen.sh' that is in the root directory. The script does all the automake/autoconf magic that needs to be done with a fresh checkout. If all steps succeed, you'll have a configure script to start off with. @@ -78,8 +78,11 @@ the GNU gettext library's developpers. Style Guide ----------- -- global functions should have the prefix "mutt_". All - other functions should be declared "static". +- global functions outside the library directory should have the prefix + "mutt_". All other functions should be declared "static". All global + functions defined within the library directory should have the the + prefix according to their source file, i.e. "str_" for everything in + lib/str.[ch] etc. - avoid global vars where possible. If one is required, try to contain it to a single source file and declare it @@ -92,13 +95,11 @@ Style Guide in ELM and PINE is the tremendous duplication of code... Help keep Mutt small! -- when adding new options, make the old behaviour the - default. +- When adding new options, make the old behaviour the default. Also, + add them to UPGRADING in the top-level source directory. - try to keep Mutt-ng as portable as possible. -- do not use C++-style comments (i.e. "// Comment") - Documentation -------------