INSTALL.REPO

   1              Building and Installing Emacs from the Repository
   2
   3 The Emacs repository is hosted on Savannah.  The following Git command
   4 will clone the repository to the 'emacs' subdirectory of the current
   5 directory on your local machine:
   6
   7     git clone git://git.sv.gnu.org/emacs.git
   8
   9 To build the repository code, simply run 'make' in the 'emacs'
  10 directory.  This should work if your files are freshly checked out
  11 from the repository, and if you have the proper tools installed.  If
  12 it doesn't work, or if you have special build requirements, the
  13 following information may be helpful.
  14
  15 Building Emacs from the source-code repository requires some tools
  16 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 git - at least Git 1.7.1.  If your repository was created by an older
  21   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 'configure' script and some related files, and to set up your git
  27 configuration:
  28
  29   $ ./autogen.sh
  30
  31 You can then configure your build as follows:
  32
  33   $ ./configure
  34
  35 The 'configure' script has many options; run './configure --help' to
  36 see them.  For example, if you want later builds to go faster, albeit
  37 sometimes doing the wrong thing if you update the build procedure, you
  38 can invoke './configure -C'.  After configuring, build Emacs as follows:
  39
  40   $ make
  41
  42 You can also type 'make check' to test and 'make install' to install
  43 Emacs.
  44
  45 Occasionally the file 'lisp/loaddefs.el' (and similar automatically
  46 generated files, such as 'esh-groups.el', and '*-loaddefs.el' in some
  47 subdirectories of 'lisp/', e.g., 'mh-e/' and 'calendar/') will need to be
  48 updated to reflect new autoloaded functions.  If you see errors (rather
  49 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.
  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 If CPU time is not an issue, 'make bootstrap' is a more thorough way
  61 to rebuild, avoiding spurious problems.
  62
  63 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 which will leave you with only files from the git repository.  Here
  66 are some faster methods for a couple of particular error cases:
  67
  68     /usr/bin/m4:aclocal.m4:9: cannot open `m4/count-leading-zeros.m4': No such file or directory
  69
  70 This can be fixed with 'rm aclocal.m4'.
  71
  72     make: *** No rule to make target 'lib/Makefile.am', needed by 'lib/Makefile.in'
  73
  74 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 sometimes fail to build.  Please wait a day or so (and check the
  78 archives of the emacs-buildstatus, emacs-devel, and bug-gnu-emacs
  79 mailing lists) before reporting such problems.  In most cases, the
  80 problem is known about and is just waiting for someone to fix it.
  81 This is especially true for Lisp compilation errors, which are almost
  82 never platform-specific.
  83
  84
  85 \f
  86 Copyright (C) 2002-2021 Free Software Foundation, Inc.
  87
  88 This file is part of GNU Emacs.
  89
  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 the Free Software Foundation, either version 3 of the License, or
  93 (at your option) any later version.
  94
  95 GNU Emacs is distributed in the hope that it will be useful,
  96 but WITHOUT ANY WARRANTY; without even the implied warranty of
  97 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  98 GNU General Public License for more details.
  99
 100 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/>.