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

3 4 5 6 7
Simply run 'make'.  This should work if your files are freshly checked
out from the repository, and if you have the proper tools installed.
If it doesn't work, or if you have special build requirements, the
following information may be helpful.

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

11
autoconf  - at least the version specified near the start of
12
  configure.ac (in the AC_PREREQ command).
13 14
git - at least Git 1.7.1.  If your repository was created by an older
  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.
17

18
To use the autotools, run the following shell command to generate the
19 20
'configure' script and some related files, and to set up your git
configuration:
21

22
  $ ./autogen.sh
23

24
You can then configure your build as follows:
25 26

  $ ./configure
27

28 29 30 31
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
32 33 34

  $ make

35 36
If you want to install Emacs, type 'make install' instead of 'make' in
the last command.
Eli Zaretskii's avatar
Eli Zaretskii committed
37

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
If either of the above partial procedures fails, try 'make bootstrap'.
53 54 55 56
If CPU time is not an issue, 'make bootstrap' is a more thorough way
to rebuild, avoiding spurious problems.

Occasionally, there are changes that 'make bootstrap' won't be able to
57
handle.  The most thorough cleaning can be achieved by 'git clean -fdx'
58 59 60 61 62 63 64 65 66 67
which will leave you with only files from the git repository.  Here
are some faster methods for a couple of particular error cases:

    /usr/bin/m4:aclocal.m4:9: cannot open `m4/count-leading-zeros.m4': No such file or directory

This can be fixed with 'rm aclocal.m4'.

    make: *** No rule to make target 'lib/Makefile.am', needed by 'lib/Makefile.in'

This can be fixed with 'rm lib/Makefile Makefile'.
68

69
Because the repository version of Emacs is a work in progress, it will
70 71 72 73 74 75
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.
76

77

78

79
Copyright (C) 2002-2019 Free Software Foundation, Inc.
80

81 82
This file is part of GNU Emacs.

83
GNU Emacs is free software: you can redistribute it and/or modify
84
it under the terms of the GNU General Public License as published by
85 86
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
87 88 89 90 91 92 93

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
94
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.