admin/make-tarball.txt

   1 Instructions to create pretest or release tarballs.
   2 -- originally written by Gerd Moellmann, amended by Francesco Potortì
   3    with the initial help of Eli Zaretskii
   4
   5 For each step, check for possible errors.
   6
   7 1.  `bzr update' (for a bound branch), or `bzr pull'.
   8      bzr status # check for locally modified files
   9
  10 2.  Bootstrap to make 100% sure all elc files are up-to-date, and to
  11     make sure that the later tagged version will bootstrap, should it be
  12     necessary to check it out.
  13
  14 3.  Regenerate Emacs' etc/AUTHORS file (M-x load-file RET
  15     lisp/emacs-lisp/authors.el RET, then M-x authors RET, then save
  16     the *Authors* buffer).  This may require fixing syntactically
  17     incorrect ChangeLog entries beforehand.
  18
  19 4.  Set the version number (M-x load-file RET admin/admin.el RET, then
  20     M-x set-version RET).  For a release, add released change log
  21     entries (M-x add-release-logs RET).
  22
  23     For a pretest, start at version .90.  After .99, use .990 (so that
  24     it sorts).
  25
  26     If needed, increment the value of the variable
  27     `customize-changed-options-previous-release' in cus-edit.el to
  28     refer to a newer release of Emacs.  (This is probably needed only
  29     when preparing a major Emacs release, or branching for it.)
  30
  31 5.  Edit configure.in so that maintainer-mode is off by default.
  32     (FIXME - need to find a better way of dealing with this).
  33
  34      autoreconf -i -I m4 --force
  35      make bootstrap
  36
  37 6.  Commit etc/AUTHORS, all the files changed by M-x set-version, and
  38     lisp/cus-edit.el (if modified).
  39     Copy lisp/loaddefs.el to lisp/ldefs-boot.el and commit lisp/ldefs-boot.el.
  40     For a release, also commit the ChangeLog files in all directories.
  41
  42 7.   make-dist --snapshot.  Check the contents of the new tar with
  43     admin/diff-tar-files against an older tar file.  Some old pretest
  44     tarballs may be found at <ftp://alpha.gnu.org/gnu/emacs/pretest>;
  45     old release tarballs are at <ftp://ftp.gnu.org/pub/gnu/emacs/>.
  46
  47     If this is the first pretest of a major release, just comparing
  48     with the previous release may overlook many new files.  You can try
  49     something like `find . | sort' in a clean bzr tree, and compare the
  50     results against the new tar contents.
  51
  52 8.   xdelta delta emacs-OLD.tar.gz emacs-NEW.tar.gz emacs-OLD-NEW.xdelta
  53
  54 9.   tar -zxf emacs-NEW.tar.gz; cd emacs-NEW
  55      ./configure && make && make -n install
  56     Use `script' or M-x compile to save the compilation log in
  57     compile-NEW.log and compare it against an old one.  The easiest way
  58     to do that is to visit the old log in Emacs, change the version
  59     number of the old Emacs to __, do the same with the new log and do
  60     M-x ediff.  Especially check that Info files aren't built.
  61
  62 10.  cd EMACS_ROOT_DIR; cvs tag TAG
  63     TAG is EMACS_PRETEST_XX_YY_ZZZ for a pretest, EMACS_XX_YY for a
  64     release.
  65
  66     Shortly before the release, cut the branch with the following commands:
  67
  68     cvs rtag EMACS_`NUMBER'_BASE
  69     cvs rtag -b EMACS_`NUMBER'_RC -r EMACS_`NUMBER'_BASE
  70
  71     where `NUMBER' is the major version number of the release.  This
  72     makes it easier to see what changes have been applied to the
  73     branch with:
  74
  75     cvs diff -r EMACS_`NUMBER'_BASE -r EMACS_`NUMBER'_RC
  76
  77     or merge changes back to the trunk with "cvs update -j", if
  78     necessary.
  79
  80     After doing this, increase the version number on the trunk as per
  81     step 4.
  82
  83     Also, open a Savannah support request asking for commits to the
  84     new branch to be sent to the emacs-diffs mailing list (by default,
  85     the list normally only gets commits to the trunk).
  86
  87 11. Now you should upload the files to the GNU ftp server.  In order to
  88     do that, you must be registered as an Emacs maintainer and have your
  89     GPG key acknowledged by the ftp people.  Mail <ftp-upload@gnu.org>
  90     for instructions.  Once you are there, for each file FILE to be
  91     released, create a detached GPG binary signature and a clearsigned
  92     directive file like this:
  93      gpg -b FILE
  94      echo directory: emacs/pretest > FILE.directive      (for a pretest)
  95      echo directory: emacs > FILE.directive              (for a release)
  96      gpg --clearsign FILE.directive
  97     Upload by anonymous ftp to ftp://ftp-upload.gnu.org/ the files FILE,
  98     FILE.sig, FILE.directive.asc.
  99     For a release, place the files in the /incoming/ftp directory.
 100     For a pretest, place the files in /incoming/alpha instead, so that
 101     they appear on ftp://alpha.gnu.org/.
 102
 103     For a release, upload a bz2 tarfile as well; this can save a lot
 104     of bandwidth.
 105
 106 12. After five minutes, verify that the files are visible at
 107     ftp://alpha.gnu.org/gnu/emacs/pretest/ for a pretest, at
 108     ftp://ftp.gnu.org/gnu/emacs/ for a release.
 109
 110 13. For a pretest, announce it on emacs-devel and BCC the pretesters.
 111     For a release, announce it on info-gnu@gnu.org,
 112     info-gnu-emacs@gnu.org, and emacs-devel.