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

3 4 5 6 7 8 9 10 11 12
The Emacs repository is hosted on Savannah.  The following Git command
will clone the repository to the 'emacs' subdirectory of the current
directory on your local machine:

    git clone git://git.sv.gnu.org/emacs.git

To build the repository code, simply run 'make' in the 'emacs'
directory.  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
13 14
following information may be helpful.

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

18
autoconf  - at least the version specified near the start of
19
  configure.ac (in the AC_PREREQ command).
20 21
git - at least Git 1.7.1.  If your repository was created by an older
  Git version, you may need to reclone it.
22
makeinfo  - not strictly necessary, but highly recommended, so that
23
  you can build the manuals.  GNU Texinfo 4.13 or later should work.
24

25
To use the autotools, run the following shell command to generate the
26 27
'configure' script and some related files, and to set up your git
configuration:
28

29
  $ ./autogen.sh
30

31
You can then configure your build as follows:
32 33

  $ ./configure
34

35 36 37 38
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
39 40 41

  $ make

42 43
You can also type 'make check' to test and 'make install' to install
Emacs.
Eli Zaretskii's avatar
Eli Zaretskii committed
44

45 46 47
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
48 49
updated to reflect new autoloaded functions.  If you see errors (rather
than warnings) about undefined lisp functions during compilation, that
50
may be the reason.  Finally, sometimes there can be build failures
51
related to '*loaddefs.el' (e.g., "required feature ‘esh-groups’ was not
52
provided").  In that case, follow the instructions below.
Glenn Morris's avatar
Glenn Morris committed
53 54

To update loaddefs.el (and similar files), do:
55 56

  $ cd lisp
57
  $ make autoloads
58

59
If either of the above partial procedures fails, try 'make bootstrap'.
60 61 62 63
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
64
handle.  The most thorough cleaning can be achieved by 'git clean -fdx'
65 66 67 68 69 70 71 72 73 74
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'.
75

76
Because the repository version of Emacs is a work in progress, it will
77 78 79 80 81 82
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.
83

84

85

86
Copyright (C) 2002-2019 Free Software Foundation, Inc.
87

88 89
This file is part of GNU Emacs.

90
GNU Emacs is free software: you can redistribute it and/or modify
91
it under the terms of the GNU General Public License as published by
92 93
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
94 95 96 97 98 99 100

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