(tooltip-mode): Doc fix.
[emacs.git] / admin / make-tarball.txt
blob3af7cb81da30806055e29b9f771551f51d692962
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
5 For each step, check for possible errors.
7 1.  cvs -q update -Pd
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.
13 3.  Regenerate Emacs' 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.
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).
22 5.  rm configure; make bootstrap
24 6.  Commit configure, README, AUTHORS, lisp/loaddefs.el,
25     lisp/cus-load.el, lisp/finder-inf.el, lisp/version.el,
26     man/emacs.texi.  For a release, also commit the ChangeLog files in
27     all directories.
29 7.  make-dist --snapshot.  Check the contents of the new tar with
30     admin/diff-tar-files against an older tar file.  Some old pretest
31     tarballs are kept under fencepost.gnu.org:~pot/emacs-pretest/, while
32     old emacs tarballs are at <ftp://ftp.gnu.org/pub/gnu/emacs/>.
34 8.  xdelta delta emacs-OLD.tar.gz emacs-NEW.tar.gz emacs-OLD-NEW.xdelta
36 9.  tar -zxf emacs-NEW.tar.gz; cd emacs-NEW
37     configure && make && make -n install
38     Use `script' or M-x compile to save the compilation log in
39     compile-NEW.log and compare it against an old one.  The easiest way
40     to do that is to visit the old log in Emacs, change the version
41     number of the old Emacs to __, do the same with the new log and do
42     M-x ediff. Especially check that Info files aren't built.
44 10. cd EMACS_ROOT_DIR; cvs tag TAG
45     TAG is EMACS_PRETEST_XX_YY_ZZZ for a pretest, EMACS_XX_YY for a
46     release.
48 11. admin/make-announcement OLD NEW
49     This creates an announcement for pretests.  OLD is the version used
50     to make deltas with respect to NEW.  Anouncements for pretests need
51     to be crafted by hand.  Use an older announcement to start with.
53 12. For the moment, put the tarballs on a public site and send a GPG
54     signed email to <maintainers@gnu.org> with the URLs of the tarballs
55     and their md5sum signatures.  As of 2003-10, the GNU maintainers are
56     working on a better procedure.  For reference, here are the previous
57     instructions, which are no more valid after the break-in of 2003-08:
58      ====
59     For a pretest, do:
60     rsync -aP emacs-NEW.tar.gz emacs-OLD-NEW.xdelta compile-NEW.log \
61     emacs-NEW.announce alpha.gnu.org:/home/alpha/gnu/emacs/pretest/.
62     For a release, do:
63     rsync -aP emacs-NEW.tar.gz emacs-OLD-NEW.xdelta \
64     alpha.gnu.org:/home/ftp/gnu/emacs/.
66 13. Verify that the files are visible at
67     ftp://alpha.gnu.org/gnu/emacs/pretest/ for a pretest, at
68     ftp://ftp.gnu.org/gnu/emacs/ for a release.
70 14. For a pretest, let Richard Stallman know about the new pretest and
71     tell him to announce it using the announcement you prepared.  Remind
72     him to set a Reply-to header to <emacs-pretest-bug@gnu.org>.
73     For a release, Richard should prepare the announcement himself,
74     possibly starting from a previous announcment.
76 # arch-tag: c23c771f-ca26-4584-8a04-50ecf0989390