Retrospective commit.
[emacs.git] / INSTALL.BZR
blob3840d5a5a7e3c4cc60d635e7f798e81224214547
1 Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
2   Free Software Foundation, Inc.
3 See the end of the file for license conditions.
6               Building and Installing Emacs from Bazaar
8 If this is the first time you go through it, you'll need to configure
9 before bootstrapping:
11   $ ./configure
13 Some of the files that are included in the Emacs tarball, such as
14 byte-compiled Lisp files, are not stored in Bazaar.  Therefore, to
15 build from Bazaar you must run "make bootstrap" instead of just "make":
17   $ bzr pull
18   $ make bootstrap
20 Normally, it is not necessary to use "make bootstrap" after every
21 update from Bazaar.  "make" should work in 90% of the cases and be
22 much quicker.
24   $ make
26 (If you want to install the Emacs binary, type "make install" instead
27 of "make" in the last command.)
29 Occasionally the file "lisp/loaddefs.el" (and similar automatically
30 generated files, such as esh-groups.el, and *-loaddefs.el in some
31 subdirectories of lisp/, e.g. mh-e/ and calendar/) will need to be
32 updated to reflect new autoloaded functions.  If you see errors (rather
33 than warnings) about undefined lisp functions during compilation, that
34 may be the reason.  Another symptom may be an error saying that
35 "loaddefs.el" could not be found; this is due to a change in the way
36 loaddefs.el was handled in version control, and should only happen
37 once, for users that are updating old sources.  Finally, sometimes
38 there can be build failures related to *loaddefs.el (e.g. "required
39 feature `esh-groups' was not provided").  In that case, follow the
40 instructions below.
42 To update loaddefs.el (and similar files), do:
44   $ cd lisp
45   $ make autoloads
47 If either of the above partial procedures fails, try "make bootstrap".
48 If CPU time is not an issue, the most thorough way to rebuild, and
49 avoid any spurious problems, is always to use this method.
51 Users of non-Posix systems (MS-Windows etc.) should run the
52 platform-specific configuration scripts (nt/configure.bat, config.bat,
53 etc.) before "make bootstrap" or "make"; the rest of the procedure is
54 applicable to those systems as well.
56 Questions, requests, and bug reports about the Bazaar versions of Emacs
57 should be sent to emacs-pretest-bug@gnu.org rather than gnu.emacs.help
58 or gnu.emacs.bug.  Ideally, use M-x report-emacs-bug RET which will
59 send it to the proper place.
61 Because the Bazaar version of Emacs is a work in progress, it will
62 sometimes fail to build.  Please wait a day or so (and check the bug
63 and development mailing list archives) before reporting such problems.
64 In most cases, the problem is known about and is just waiting for
65 someone to fix it.
68 Note on accessing the Bazaar repository
69 ---------------------------------------
71 Write access to the Bazaar repository is currently done via Bazaar's
72 sftp:// protocol; see http://www.emacswiki.org/emacs/BzrForEmacsDevs.
73 We plan to offer bzr+ssh:// access later.  More discussion about that
74 is at https://savannah.gnu.org/support/?107077.
78 This file is part of GNU Emacs.
80 GNU Emacs is free software: you can redistribute it and/or modify
81 it under the terms of the GNU General Public License as published by
82 the Free Software Foundation, either version 3 of the License, or
83 (at your option) any later version.
85 GNU Emacs is distributed in the hope that it will be useful,
86 but WITHOUT ANY WARRANTY; without even the implied warranty of
87 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
88 GNU General Public License for more details.
90 You should have received a copy of the GNU General Public License
91 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.