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