; Merge from origin/emacs-25
[emacs.git] / INSTALL.REPO
blob6fc9857b9da8f394771648cd45caf22947d4d76c
1              Building and Installing Emacs from the Repository
3 Simply run 'make'.  This should work if your files are freshly checked
4 out from the repository, and if you have the proper tools installed.
5 If it doesn't work, or if you have special build requirements, the
6 following information may be helpful.
8 Building Emacs from the source-code repository requires some tools
9 that are not needed when building from a release.  You will need:
11 autoconf  - at least the version specified near the start of
12   configure.ac (in the AC_PREREQ command).
13 automake  - at least the version specified near the start of
14   configure.ac (in the AM_INIT_AUTOMAKE command).
15 git - at least Git 1.7.1.  If your repository was created by an older
16   Git version, you may need to reclone it.
17 makeinfo  - not strictly necessary, but highly recommended, so that
18   you can build the manuals.  GNU Texinfo 4.13 or later should work.
20 To use the autotools, run the following shell command to generate the
21 'configure' script and some related files, and to set up your git
22 configuration:
24   $ ./autogen.sh all
26 You can then configure your build as follows:
28   $ ./configure
30 The 'configure' script has many options; run './configure --help' to
31 see them.  For example, if you want later builds to go faster, albeit
32 sometimes doing the wrong thing if you update the build procedure, you
33 can invoke './configure -C'.  After configuring, build Emacs as follows:
35   $ make
37 If you want to install Emacs, type 'make install' instead of 'make' in
38 the last command.
40 Occasionally the file 'lisp/loaddefs.el' (and similar automatically
41 generated files, such as 'esh-groups.el', and '*-loaddefs.el' in some
42 subdirectories of 'lisp/', e.g., 'mh-e/' and 'calendar/') will need to be
43 updated to reflect new autoloaded functions.  If you see errors (rather
44 than warnings) about undefined lisp functions during compilation, that
45 may be the reason.  Finally, sometimes there can be build failures
46 related to '*loaddefs.el' (e.g., "required feature ‘esh-groups’ was not
47 provided").  In that case, follow the instructions below.
49 To update loaddefs.el (and similar files), do:
51   $ cd lisp
52   $ make autoloads
54 If either of the above partial procedures fails, try 'make bootstrap'.
55 If CPU time is not an issue, 'make bootstrap' is the most thorough way
56 to rebuild, and avoid any spurious problems.
58 Because the repository version of Emacs is a work in progress, it will
59 sometimes fail to build.  Please wait a day or so (and check the
60 archives of the emacs-buildstatus, emacs-devel, and bug-gnu-emacs
61 mailing lists) before reporting such problems.  In most cases, the
62 problem is known about and is just waiting for someone to fix it.
63 This is especially true for Lisp compilation errors, which are almost
64 never platform-specific.
68 Copyright (C) 2002-2016 Free Software Foundation, Inc.
70 This file is part of GNU Emacs.
72 GNU Emacs is free software: you can redistribute it and/or modify
73 it under the terms of the GNU General Public License as published by
74 the Free Software Foundation, either version 3 of the License, or
75 (at your option) any later version.
77 GNU Emacs is distributed in the hope that it will be useful,
78 but WITHOUT ANY WARRANTY; without even the implied warranty of
79 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
80 GNU General Public License for more details.
82 You should have received a copy of the GNU General Public License
83 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.