; Spelling fixes
[emacs.git] / INSTALL.REPO
blob1b56b0b9347bda1b9e1485b576b7cb970f688721
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 git - at least Git 1.7.1.  If your repository was created by an older
14   Git version, you may need to reclone it.
15 makeinfo  - not strictly necessary, but highly recommended, so that
16   you can build the manuals.  GNU Texinfo 4.13 or later should work.
18 To use the autotools, run the following shell command to generate the
19 'configure' script and some related files, and to set up your git
20 configuration:
22   $ ./autogen.sh all
24 You can then configure your build as follows:
26   $ ./configure
28 The 'configure' script has many options; run './configure --help' to
29 see them.  For example, if you want later builds to go faster, albeit
30 sometimes doing the wrong thing if you update the build procedure, you
31 can invoke './configure -C'.  After configuring, build Emacs as follows:
33   $ make
35 If you want to install Emacs, type 'make install' instead of 'make' in
36 the last command.
38 Occasionally the file 'lisp/loaddefs.el' (and similar automatically
39 generated files, such as 'esh-groups.el', and '*-loaddefs.el' in some
40 subdirectories of 'lisp/', e.g., 'mh-e/' and 'calendar/') will need to be
41 updated to reflect new autoloaded functions.  If you see errors (rather
42 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.
47 To update loaddefs.el (and similar files), do:
49   $ cd lisp
50   $ make autoloads
52 If either of the above partial procedures fails, try 'make bootstrap'.
53 If CPU time is not an issue, 'make bootstrap' is the most thorough way
54 to rebuild, and avoid any spurious problems.
56 Because the repository version of Emacs is a work in progress, it will
57 sometimes fail to build.  Please wait a day or so (and check the
58 archives of the emacs-buildstatus, emacs-devel, and bug-gnu-emacs
59 mailing lists) before reporting such problems.  In most cases, the
60 problem is known about and is just waiting for someone to fix it.
61 This is especially true for Lisp compilation errors, which are almost
62 never platform-specific.
66 Copyright (C) 2002-2017 Free Software Foundation, Inc.
68 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 the Free Software Foundation, either version 3 of the License, or
73 (at your option) any later version.
75 GNU Emacs is distributed in the hope that it will be useful,
76 but WITHOUT ANY WARRANTY; without even the implied warranty of
77 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
78 GNU General Public License for more details.
80 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/>.