Prefer UTF-8 when the encoding shouldn't matter and changes are small.
[bpt/emacs.git] / admin / make-tarball.txt
CommitLineData
c38e0c97
PE
1Instructions to create pretest or release tarballs. -*- coding: utf-8 -*-
2-- originally written by Gerd Moellmann, amended by Francesco Potortì
383c1c75 3 with the initial help of Eli Zaretskii
90073820 4
90073820 5
31045a5b
GM
6Steps to take before starting on the first pretest in any release sequence:
7
81. Decide on versions of automake and autoconf, and ensure you will
7d2707f9
GM
9 have them available for the duration of the release process.
10
31045a5b
GM
112. Consider increasing the value of the variable
12 `customize-changed-options-previous-release' in cus-edit.el to
13 refer to a newer version of Emacs. (This is probably needed only
14 when preparing the first pretest for a major Emacs release.)
15 Commit cus-edit.el if changed.
16
17
18General steps (for each step, check for possible errors):
19
1a71dc49 201. `bzr update' (for a bound branch), or `bzr pull'.
31045a5b 21 bzr status # check for locally modified files
90073820
FP
22
232. Bootstrap to make 100% sure all elc files are up-to-date, and to
24 make sure that the later tagged version will bootstrap, should it be
25 necessary to check it out.
26
7d2707f9 273. Regenerate the etc/AUTHORS file:
31045a5b
GM
28 M-: (require 'authors) RET
29 M-x authors RET
30
31 There is almost guaranteed to be an "*Authors Errors*" buffer with
32 problems caused by certain bad ChangeLog entries. You can ignore
33 the very old ones (eg lisp/erc has a lot). If there are errors
34 related to new entries (especially entries that are new since the
35 last pretest), see if you can fix them. If there was a ChangeLog
36 typo, fix it. If a file was deleted or renamed, consider adding
37 an appropriate entry to authors-ignored-files, authors-valid-file-names,
38 or authors-renamed-files-alist.
39
40 If necessary, repeat M-x authors after making those changes.
41 Save the "*Authors*" buffer as etc/AUTHORS.
42 Check the diff looks reasonable. Maybe add entries to
43 authors-ambiguous-files or authors-aliases, and repeat.
44 Commit any fixes to ChangeLogs or authors.el.
c0982072
LK
45
464. Set the version number (M-x load-file RET admin/admin.el RET, then
7d2707f9 47 M-x set-version RET). For a release, add released ChangeLog
90073820
FP
48 entries (M-x add-release-logs RET).
49
3baeb95e
GM
50 For a pretest, start at version .90. After .99, use .990 (so that
51 it sorts).
52
501390c5 535. autoreconf -i -I m4 --force
54aa48fe 54 make bootstrap
90073820 55
31045a5b
GM
566. Copy lisp/loaddefs.el to lisp/ldefs-boot.el.
57
58 Commit etc/AUTHORS, lisp/ldefs-boot.el, and the files changed
59 by M-x set-version.
1a71dc49 60 For a release, also commit the ChangeLog files in all directories.
90073820 61
31045a5b
GM
627. ./make-dist --snapshot --no-compress
63
64 Check the contents of the new tar with
54aa48fe 65 admin/diff-tar-files against an older tar file. Some old pretest
1a71dc49
GM
66 tarballs may be found at <ftp://alpha.gnu.org/gnu/emacs/pretest>;
67 old release tarballs are at <ftp://ftp.gnu.org/pub/gnu/emacs/>.
90073820 68
c789f32c
GM
69 If this is the first pretest of a major release, just comparing
70 with the previous release may overlook many new files. You can try
1a71dc49
GM
71 something like `find . | sort' in a clean bzr tree, and compare the
72 results against the new tar contents.
c789f32c 73
31045a5b
GM
748. tar -xf emacs-NEW.tar; cd emacs-NEW
75 ./configure --prefix=/tmp/emacs && make && make install
7d5c9c1b
FP
76 Use `script' or M-x compile to save the compilation log in
77 compile-NEW.log and compare it against an old one. The easiest way
78 to do that is to visit the old log in Emacs, change the version
79 number of the old Emacs to __, do the same with the new log and do
834671a6 80 M-x ediff. Especially check that Info files aren't built.
7d5c9c1b 81
31045a5b 829. cd EMACS_ROOT_DIR && bzr tag TAG
1e1bbf41 83 TAG is emacs-XX.Y.ZZ for a pretest, emacs-XX.Y for a release.
7d5c9c1b 84
ab22a8a1
CY
85 Shortly before the release, cut the version branch also, and open
86 a Savannah support request asking for commits to the new branch to
87 be sent to the emacs-diffs mailing list (by default, the list
88 normally only gets commits to the trunk).
e8ccb869 89
31045a5b
GM
9010. Decide what compression schemes to offer.
91 For a release, at least gz and xz:
92 gzip --best -c emacs-NEW.tar > emacs-NEW.tar.gz
93 xz -c emacs-NEW.tar > emacs-NEW.tar.xz
94
95 Now you should upload the files to the GNU ftp server. In order to
140281f6 96 do that, you must be registered as an Emacs maintainer and have your
a0b4e66e
GM
97 GPG key acknowledged by the ftp people. For instructions, see
98 http://www.gnu.org/prep/maintain/html_node/Automated-Upload-Registration.html
31045a5b
GM
99 The simplest method is to use the gnulib <http://www.gnu.org/s/gnulib/>
100 script "build-aux/gnupload" to upload each FILE, like this:
101
102 For a pretest:
103 gnupload [--user your@gpg.key.email] --to alpha.gnu.org:emacs/pretest \
104 FILE.gz FILE.xz ...
105
106 For a release:
107 gnupload [--user your@gpg.key.email] --to ftp.gnu.org:emacs \
108 FILE.gz FILE.xz ...
109
110 You only need the --user part if you have multiple GPG keys and do
111 not want to use the default.
112 Obviously, if you do not have a fast uplink, be prepared for the
113 upload to take a while.
114
115
116 If you prefer to do it yourself rather than use gnupload:
117
118 For each FILE, create a detached GPG binary signature and a
119 clearsigned directive file like this:
ab22a8a1 120
140281f6
FP
121 gpg -b FILE
122 echo directory: emacs/pretest > FILE.directive (for a pretest)
123 echo directory: emacs > FILE.directive (for a release)
124 gpg --clearsign FILE.directive
7dee3a04
RF
125 Upload by anonymous ftp to ftp://ftp-upload.gnu.org/ the files FILE,
126 FILE.sig, FILE.directive.asc.
127 For a release, place the files in the /incoming/ftp directory.
128 For a pretest, place the files in /incoming/alpha instead, so that
129 they appear on ftp://alpha.gnu.org/.
140281f6 130
7d2707f9 13111. After five minutes, verify that the files are visible at
31045a5b 132 ftp://alpha.gnu.org/gnu/emacs/pretest/ for a pretest, or
41a3c7b0
FP
133 ftp://ftp.gnu.org/gnu/emacs/ for a release.
134
31045a5b
GM
135 Download them and check the signatures. Check they build.
136
7d2707f9
GM
13712. For a pretest, announce it on emacs-devel and info-gnu-emacs@gnu.org.
138 For a release, also announce it on info-gnu@gnu.org. (Probably
139 bcc the info- addresses to make it less likely that people will
140 followup on those lists.)
50b2d54c 141
7d2707f9 14213. For a release, update the Emacs homepage in the web repository.
50b2d54c 143 Also add the new NEWS file as NEWS.xx.y.
31045a5b 144 Maybe regenerate the html manuals, update the FAQ, etc, etc.