]> code.delx.au - gnu-emacs/blobdiff - admin/make-tarball.txt
Generate a ChangeLog file from commit logs
[gnu-emacs] / admin / make-tarball.txt
index 8f8b031ba2f46b03504eab0bf5df01cd88af889b..8190e9edb8528bc2d3489e2c1751b209f7d4f887 100644 (file)
@@ -31,30 +31,37 @@ General steps (for each step, check for possible errors):
       M-x authors RET
 
     If there is an "*Authors Errors*" buffer, address the issues.
-    If there was a ChangeLog typo, fix it.  If a file was deleted or
-    renamed, consider adding an appropriate entry to authors-ignored-files,
-    authors-valid-file-names, or authors-renamed-files-alist.
+    If there was a ChangeLog typo, run "make change-history" and then
+    fix the newest ChangeLog history file.  If a file was deleted or
+    renamed, consider adding an appropriate entry to
+    authors-ignored-files, authors-valid-file-names, or
+    authors-renamed-files-alist.
 
     If necessary, repeat M-x authors after making those changes.
     Save the "*Authors*" buffer as etc/AUTHORS.
     Check the diff looks reasonable.  Maybe add entries to
     authors-ambiguous-files or authors-aliases, and repeat.
-    Commit any fixes to ChangeLogs or authors.el.
+    Commit any fixes to authors.el.
 
 3.  Set the version number (M-x load-file RET admin/admin.el RET, then
     M-x set-version RET).  For a release, add released ChangeLog
-    entries (M-x add-release-logs RET).
+    entries (create a ChangeLog symlink a la vc-dwim, then run M-x
+    add-release-logs RET, then run the shell command 'vc-dwim --commit').
 
     For a pretest, start at version .90.  After .99, use .990 (so that
     it sorts).
 
     The final pretest should be a release candidate.  Set the version
     number to that of the actual release.  Pick a date about a week
-    from now when you intend to make the release.  Use M-x add-release-logs
-    to add the ChangeLog entries for that date to the tar file (but
-    not yet to the repository).  Name the tar file as
-    emacs-XX.Y-rc1.tar.  If all goes well in the following week, you
-    can simply rename the file and use it for the actual release.
+    from now when you intend to make the release.  Use vc-dwim and
+    M-x add-release-logs as described above to add commit messages
+    that will appear in the tarball's automatically-generated ChangeLog
+    file as entries for that date.
+
+    Name the tar file as emacs-XX.Y-rc1.tar.  If all goes well in the
+    following week, you can simply rename the file and use it for the
+    actual release.  If you need another release candidate, remember
+    to adjust the ChangeLog entries.
 
 4.   autoreconf -i -I m4 --force
      make bootstrap
@@ -65,8 +72,7 @@ General steps (for each step, check for possible errors):
 5.  Copy lisp/loaddefs.el to lisp/ldefs-boot.el.
 
     Commit etc/AUTHORS, lisp/ldefs-boot.el, and the files changed
-    by M-x set-version. For a release, also commit the ChangeLog
-    files in all directories.
+    by M-x set-version.
 
     If someone else made a commit between step 1 and now,
     you need to repeat from step 4 onwards.  (You can commit the files