INSTALL.REPO 3.26 KB
Newer Older
1
	     Building and Installing Emacs from the Repository
Eli Zaretskii's avatar
Eli Zaretskii committed
2

3 4
Building Emacs from the source-code repository requires some tools
that are not needed when building from a release.  You will need:
5

6
autoconf  - at least the version specified near the start of
7
  configure.ac (in the AC_PREREQ command).
8 9
automake  - at least the version specified near the start of
  configure.ac (in the AM_INIT_AUTOMAKE command).
10 11 12
makeinfo  - not strictly necessary, but highly recommended, so that
  you can build the manuals.

13 14
To use the autotools, run the following shell command to generate the
'configure' script and some related files:
15 16

  $ ./autogen.sh
17

18
You can then configure your build as follows:
19 20

  $ ./configure
21

22 23 24 25
The 'configure' script has many options; run './configure --help' to
see them.  For example, if you want later builds to go faster, albeit
sometimes doing the wrong thing if you update the build procedure, you
can invoke './configure -C'.  After configuring, build Emacs as follows:
Eli Zaretskii's avatar
Eli Zaretskii committed
26 27 28

  $ make

29 30
If you want to install Emacs, type 'make install' instead of 'make' in
the last command.
Eli Zaretskii's avatar
Eli Zaretskii committed
31

32 33 34 35 36 37
After your first build, you can usually just run 'make' after any
updates from the Savannah repository or local edits; the makefile
contains logic to re-run configure as needed. However, if the autoconf
input files have changed, or in some other situations, you will need
to run 'make bootstrap' (more below).

38 39 40
Occasionally the file 'lisp/loaddefs.el' (and similar automatically
generated files, such as 'esh-groups.el', and '*-loaddefs.el' in some
subdirectories of 'lisp/', e.g., 'mh-e/' and 'calendar/') will need to be
41 42
updated to reflect new autoloaded functions.  If you see errors (rather
than warnings) about undefined lisp functions during compilation, that
43
may be the reason.  Finally, sometimes there can be build failures
44
related to '*loaddefs.el' (e.g., "required feature `esh-groups' was not
45
provided").  In that case, follow the instructions below.
Glenn Morris's avatar
Glenn Morris committed
46 47

To update loaddefs.el (and similar files), do:
48 49

  $ cd lisp
50
  $ make autoloads
51

52 53 54
If either of the above partial procedures fails, try 'make bootstrap'.
If CPU time is not an issue, 'make bootstrap' is the most thorough way
to rebuild, and avoid any spurious problems.
55

56
Because the repository version of Emacs is a work in progress, it will
57 58 59 60 61 62
sometimes fail to build.  Please wait a day or so (and check the
archives of the emacs-buildstatus, emacs-devel, and bug-gnu-emacs
mailing lists) before reporting such problems.  In most cases, the
problem is known about and is just waiting for someone to fix it.
This is especially true for Lisp compilation errors, which are almost
never platform-specific.
63

64

65

66 67
Copyright (C) 2002-2014 Free Software Foundation, Inc.

68 69
This file is part of GNU Emacs.

70
GNU Emacs is free software: you can redistribute it and/or modify
71
it under the terms of the GNU General Public License as published by
72 73
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
74 75 76 77 78 79 80

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
81
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.