Last pass at README.developers -- Kimmo's 5-step commit was overkill. You only
[mmh] / docs / README.developers
index b243b5d..9edd701 100644 (file)
@@ -44,17 +44,20 @@ around with `touch'.
 The correct procedure to commit the configure-related files is:
 
     % cvs commit acconfig.h aclocal.m4 configure.in
-    % autoconf && autoheader
-    % cvs commit config.h.in configure
-    % make stamp-h.in
-    % cvs commit stamp-h.in
-
-If you haven't changed all of those files, just commit the rest in the stated
-order (e.g. cvs commit acconfig.h config.h.in stamp-h.in).  The reason for
-the sequence is the RCS Id strings in the edited files -- they change when
-you commit the changes.
-
-You can run just "make" instead of the other commands in between cvs commits.
+    % autoheader; autoconf; date > stamp-h.in
+    % cvs commit config.h.in configure stamp-h.in
+
+The reason for the three-step commit is that configure.in contains the RCS $Id
+keyword, so when you commit it, a new version is written locally.  Therefore,
+the autoconf regeneration should be held off until after the commit, or your
+local stamp-h.in will become out-of-sync with the CVS version (granted, not that
+big a deal).  For the second step, you're doing the same commands as a 
+`make reset' would do, but using that command would require extra configure runs
+to make Makefile be up-to-date.
+
+If you haven't changed all the files noted above, just commit the ones you have
+changed, in the stated order (for instance, configure.in, then configure and
+stamp-h.in).
 
 
 -------------------