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.   cvs -q update -Pd
   8
   9 2.  Bootstrap to make 100% sure all elc files are up-to-date, and to
  10     make sure that the later tagged version will bootstrap, should it be
  11     necessary to check it out.
  12
  13 3.  Regenerate Emacs' etc/AUTHORS file (M-x load-file RET
  14     lisp/emacs-lisp/authors.el RET, then M-x authors RET, then save
  15     the *Authors* buffer).  This may require fixing syntactically
  16     incorrect ChangeLog entries beforehand.
  17
  18 4.  Set the version number (M-x load-file RET admin/admin.el RET, then
  19     M-x set-version RET).  For a release, add released change log
  20     entries (M-x add-release-logs RET).
  21
  22     For a pretest, start at version .90.  After .99, use .990 (so that
  23     it sorts).
  24
  25 5.  rm configure; autoconf
  26
  27     Patch configure: See
  28     http://lists.gnu.org/archive/html/emacs-devel/2009-02/msg00851.html
  29
  30     make bootstrap
  31
  32 6.  Commit configure, README, doc/emacs/emacs.texi,
  33     doc/lispref/elisp.texi, etc/AUTHORS, lisp/version.el,
  34     nt/emacs.rc.  Copy lisp/loaddefs.el to
  35     lisp/ldefs-boot.el and commit lisp/ldefs-boot.el.  For a release,
  36     also commit the ChangeLog files in all directories.
  37
  38 7.   make-dist --snapshot.  Check the contents of the new tar with
  39      admin/diff-tar-files against an older tar file.  Some old pretest
  40     tarballs are kept under fencepost.gnu.org:~pot/emacs-pretest/, while
  41     old emacs tarballs are at <ftp://ftp.gnu.org/pub/gnu/emacs/>.
  42
  43     If this is the first pretest of a major release, just comparing
  44     with the previous release may overlook many new files.  You can try
  45     something like `find -f | grep -v CVS...etc' in a clean CVS tree,
  46     and compare the results against the new tar contents.
  47
  48 8.   xdelta delta emacs-OLD.tar.gz emacs-NEW.tar.gz emacs-OLD-NEW.xdelta
  49
  50 9.   tar -zxf emacs-NEW.tar.gz; cd emacs-NEW
  51      ./configure && make && make -n install
  52     Use `script' or M-x compile to save the compilation log in
  53     compile-NEW.log and compare it against an old one.  The easiest way
  54     to do that is to visit the old log in Emacs, change the version
  55     number of the old Emacs to __, do the same with the new log and do
  56     M-x ediff.  Especially check that Info files aren't built.
  57
  58 10.  cd EMACS_ROOT_DIR; cvs tag TAG
  59     TAG is EMACS_PRETEST_XX_YY_ZZZ for a pretest, EMACS_XX_YY for a
  60     release.
  61
  62     Shortly before the release, cut the branch with the following commands:
  63
  64     cvs rtag EMACS_`NUMBER'_BASE
  65     cvs rtag -b EMACS_`NUMBER'_RC -r EMACS_`NUMBER'_BASE
  66
  67     where `NUMBER' is the major version number of the release.  This
  68     makes it easier to see what changes have been applied to the
  69     branch with:
  70
  71     cvs diff -r EMACS_`NUMBER'_BASE -r EMACS_`NUMBER'_RC
  72
  73     or merge changes back to the trunk with "cvs update -j", if
  74     necessary.
  75
  76     After doing this, increase the version number on the trunk as per
  77     step 4.
  78
  79 11. Now you should upload the files to the GNU ftp server.  In order to
  80     do that, you must be registered as an Emacs maintainer and have your
  81     GPG key acknowledged by the ftp people.  Mail <ftp-upload@gnu.org>
  82     for instructions.  Once you are there, for each file FILE to be
  83     released, create a detached GPG binary signature and a clearsigned
  84     directive file like this:
  85      gpg -b FILE
  86      echo directory: emacs/pretest > FILE.directive      (for a pretest)
  87      echo directory: emacs > FILE.directive              (for a release)
  88      gpg --clearsign FILE.directive
  89     Upload by anonymous ftp to ftp://ftp-upload.gnu.org/ the files FILE,
  90     FILE.sig, FILE.directive.asc.
  91     For a release, place the files in the /incoming/ftp directory.
  92     For a pretest, place the files in /incoming/alpha instead, so that
  93     they appear on ftp://alpha.gnu.org/.
  94
  95     For a release, upload a bz2 tarfile as well; this can save a lot
  96     of bandwidth.
  97
  98 12. After five minutes, verify that the files are visible at
  99     ftp://alpha.gnu.org/gnu/emacs/pretest/ for a pretest, at
 100     ftp://ftp.gnu.org/gnu/emacs/ for a release.
 101
 102 13. For a pretest, announce it on emacs-devel and BCC the pretesters.
 103     For a release, announce it on info-gnu@gnu.org,
 104     info-gnu-emacs@gnu.org, and emacs-devel.
 105
 106
 107 # arch-tag: c23c771f-ca26-4584-8a04-50ecf0989390