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.   autoreconf -i -I m4 --force
  32      make bootstrap
  33
  34 6.  Commit etc/AUTHORS, all the files changed by M-x set-version, and
  35     lisp/cus-edit.el (if modified).
  36     Copy lisp/loaddefs.el to lisp/ldefs-boot.el and commit lisp/ldefs-boot.el.
  37     For a release, also commit the ChangeLog files in all directories.
  38
  39 7.   make-dist --snapshot.  Check the contents of the new tar with
  40     admin/diff-tar-files against an older tar file.  Some old pretest
  41     tarballs may be found at <ftp://alpha.gnu.org/gnu/emacs/pretest>;
  42     old release tarballs are at <ftp://ftp.gnu.org/pub/gnu/emacs/>.
  43
  44     If this is the first pretest of a major release, just comparing
  45     with the previous release may overlook many new files.  You can try
  46     something like `find . | sort' in a clean bzr tree, and compare the
  47     results against the new tar contents.
  48
  49 8.   xdelta delta emacs-OLD.tar.gz emacs-NEW.tar.gz emacs-OLD-NEW.xdelta
  50
  51 9.   tar -zxf emacs-NEW.tar.gz; cd emacs-NEW
  52      ./configure && make && make -n install
  53     Use `script' or M-x compile to save the compilation log in
  54     compile-NEW.log and compare it against an old one.  The easiest way
  55     to do that is to visit the old log in Emacs, change the version
  56     number of the old Emacs to __, do the same with the new log and do
  57     M-x ediff.  Especially check that Info files aren't built.
  58
  59 10.  cd EMACS_ROOT_DIR; bzr tag TAG
  60     TAG is EMACS_PRETEST_XX_YY_ZZZ for a pretest, EMACS_XX_YY for a
  61     release.
  62
  63     Shortly before the release, cut the version branch also, and open
  64     a Savannah support request asking for commits to the new branch to
  65     be sent to the emacs-diffs mailing list (by default, the list
  66     normally only gets commits to the trunk).
  67
  68 11. Now you should upload the files to the GNU ftp server.  In order to
  69     do that, you must be registered as an Emacs maintainer and have your
  70     GPG key acknowledged by the ftp people.  Mail <ftp-upload@gnu.org>
  71     for instructions.
  72
  73     You can use the gnupload script to upload each FILE, like this:
  74      gnupload --to alpha.gnu.org:emacs/pretest FILE (for a pretest)
  75      gnupload --to ftp.gnu.org:emacs FILE           (for a release)
  76
  77     Instead of using gnupload, for each FILE, create a detached GPG
  78     binary signature and a clearsigned directive file like this:
  79      gpg -b FILE
  80      echo directory: emacs/pretest > FILE.directive      (for a pretest)
  81      echo directory: emacs > FILE.directive              (for a release)
  82      gpg --clearsign FILE.directive
  83     Upload by anonymous ftp to ftp://ftp-upload.gnu.org/ the files FILE,
  84     FILE.sig, FILE.directive.asc.
  85     For a release, place the files in the /incoming/ftp directory.
  86     For a pretest, place the files in /incoming/alpha instead, so that
  87     they appear on ftp://alpha.gnu.org/.
  88
  89     For a release, upload a bz2 tarfile as well; this can save a lot
  90     of bandwidth.
  91
  92 12. After five minutes, verify that the files are visible at
  93     ftp://alpha.gnu.org/gnu/emacs/pretest/ for a pretest, at
  94     ftp://ftp.gnu.org/gnu/emacs/ for a release.
  95
  96 13. For a pretest, announce it on emacs-devel and BCC the pretesters.
  97     For a release, announce it on info-gnu@gnu.org,
  98     info-gnu-emacs@gnu.org, and emacs-devel.
  99
 100 14. For a release, update the Emacs homepage in the web repository.
 101     Also add the new NEWS file as NEWS.xx.y.