X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=docs%2FREADME.developers;h=cba9f46cbc83df941c98acb47423fa46224bdb08;hb=318ee655d8080cbc1e8edc573ca91672659b2dee;hp=2946d8c1b54f5e9a44e6ff60d158deff1d8a3051;hpb=e4ccf20dcb722d8110e2a22f03e960e8f9f67898;p=mmh diff --git a/docs/README.developers b/docs/README.developers index 2946d8c..cba9f46 100644 --- a/docs/README.developers +++ b/docs/README.developers @@ -9,23 +9,34 @@ local info best encoded in a comment) are encouraged to share their wisdom here. The topics are organized alphabetically. --------------- -autoconf files --------------- - -If you wish to change the `configure' script or its related files, you'll need -to first install GNU m4, available from and then -GNU autoconf (). Nmh is currently using -a minimum of autoconf 2.61. - -Most of the configure-related files are automatically generated. The only files -you should need to manually edit are configure.ac and aclocal.m4. Don't, for -instance, edit config.h.in. Though it is an input file from the point of view -of the users (and the configure script) it is an output file from the point of -view of the developers (and the autoconf script). - -Note that the automatically generated autoconf files (such as config.h.in, -stamp-h.in, and configure), are NOT kept in git. Thus, when you check out +------------------------- +autoconf & automake files +------------------------- + +If you wish to change the `configure' script, the generated Makefile +or other related files, you'll need to first install GNU m4, available +from , then GNU autoconf +() and GNU automake +(). Nmh is currently using a +minimum of autoconf 2.61 and automake 1.10. + +Most of the configure-related files are automatically generated. +The only files you should need to manually edit are configure.ac +and any autoconf macros in the m4 directory. Don't, for instance, +edit config.h.in. Though it is an input file from the point of +view of the users (and the configure script) it is an output file +from the point of view of the developers (and the autoconf script). + +If you wish to add a new autoconf macro, it should be placed in it's +own file and put in the m4 directory; aclocal will automatically pick +it up and automake will add it to the distribution target automatically. + +If you wish to make changes to the Makefile, you will need to edit +Makefile.am. See the automake documentation if you need further help. +You should always check changes to Makefile.am by using "make distcheck". + +Note that the automatically generated autotools files (such as config.h.in, +Makefile.in, and configure), are NOT kept in git. Thus, when you check out a git tree, you need to run the autogen.sh script before you can build anything: