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