INSTALL.CVS

   1 Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
   2   Free Software Foundation, Inc.
   3 See the end of the file for license conditions.
   4
   5
   6               Building and Installing Emacs from CVS
   7
   8 Some of the files that are included in the Emacs tarball, such as
   9 byte-compiled Lisp files, are not stored in the CVS repository.
  10 Therefore, to build from CVS you must run "make bootstrap"
  11 instead of just "make":
  12
  13   $ cvs update -dP
  14   $ ./configure
  15   $ make bootstrap
  16
  17 The bootstrap process makes sure all necessary files are rebuilt
  18 before it builds the final Emacs binary.  Unfortunately, it doesn't
  19 always work when there are stale files from a previous build in the
  20 directory tree.
  21
  22 So if 'make bootstrap' fails, it may be necessary first to do 'make
  23 maintainer-clean' to clear out these stale files.  You can then try
  24 again, starting with `./configure'.  (Occasionally the loaddefs.el
  25 file gets into a bad state due to changes in the Lisp libraries; this
  26 procedure forces it to be regenerated.)
  27
  28 Normally, it is not necessary to use "make bootstrap" after every CVS
  29 update.  Unless there are problems, we suggest using the following
  30 alternative procedure after you have done "make bootstrap" at least
  31 once:
  32
  33   $ ./configure
  34   $ make
  35   $ cd lisp
  36   $ make recompile EMACS=../src/emacs
  37   $ cd ..
  38   $ make
  39
  40 (If you want to install the Emacs binary, type "make install" instead
  41 of "make" in the last command.)
  42
  43 Occasionally the file "lisp/loaddefs.el" (and similar automatically
  44 generated files, such as esh-groups.el, and *-loaddefs.el in some
  45 subdirectories of lisp/, e.g. mh-e/ and calendar/) will need to be
  46 updated to reflect new autoloaded functions.  If you see errors (rather
  47 than warnings) about undefined lisp functions during compilation, that
  48 may be the reason.  Another symptom may be an error saying that
  49 "loaddefs.el" could not be found; this is due to a change in the way
  50 loaddefs.el was handled in CVS, and should only happen once, for users
  51 that are updating old CVS trees.  Finally, sometimes there can be build
  52 failures related to *loaddefs.el (e.g. "required feature `esh-groups'
  53 was not provided").  In that case, follow the instructions below.
  54
  55 To update loaddefs.el (and similar files), do:
  56
  57   $ cd lisp
  58   $ make autogen-clean
  59   $ make autoloads EMACS=../src/emacs
  60
  61 If either of the above partial procedures fails, try "make bootstrap".
  62
  63 Very occasionally changes in the source can introduce
  64 incompatibilities with previous builds.  If a bootstrap fails, as a
  65 last resort try "make maintainer-clean" before configuring and
  66 bootstrapping again.  If CPU time is not an issue, the most thorough
  67 way to rebuild, and avoid any spurious problems, is always to use this
  68 method.
  69
  70 Users of non-Posix systems (MS-Windows etc.) should run the
  71 platform-specific configuration scripts (nt/configure.bat, config.bat,
  72 etc.) before "make bootstrap" or "make"; the rest of the procedure is
  73 applicable to those systems as well, except that the value of the
  74 EMACS variable on the Make command line might be different, e.g.,
  75 ../bin/emacs.exe or some such.
  76
  77 Questions, requests, and bug reports about the CVS versions of Emacs
  78 should be sent to emacs-pretest-bug@gnu.org rather than gnu.emacs.help
  79 or gnu.emacs.bug.  Ideally, use M-x report-emacs-bug RET which will
  80 send it to the proper place.
  81
  82
  83 Note on using SSH to access the CVS repository from inside Emacs
  84 ----------------------------------------------------------------
  85
  86 Write access to the CVS repository requires using SSH v2.
  87
  88 If you execute cvs commands inside Emacs, specifically if you use
  89 pcl-cvs, output from CVS may be lost due to a problem in the
  90 interface between ssh, cvs, and libc.  Corrupted checkins are
  91 also known to have happened.
  92
  93 To fix the problem, save the following script into a file, make it
  94 executable, and set CVS_RSH to the file name of the script:
  95
  96 #!/bin/bash
  97 exec 2> >(exec cat >&2 2>/dev/null)
  98 exec ssh "$@"
  99
 100 This may be combined with the following entry in ~/.ssh/config to
 101 simplify accessing the CVS repository:
 102
 103 Host subversions.gnu.org
 104      Protocol 2
 105      ForwardX11 no
 106      User YOUR_USERID
 107
 108 \f
 109 This file is part of GNU Emacs.
 110
 111 GNU Emacs is free software: you can redistribute it and/or modify
 112 it under the terms of the GNU General Public License as published by
 113 the Free Software Foundation, either version 3 of the License, or
 114 (at your option) any later version.
 115
 116 GNU Emacs is distributed in the hope that it will be useful,
 117 but WITHOUT ANY WARRANTY; without even the implied warranty of
 118 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 119 GNU General Public License for more details.
 120
 121 You should have received a copy of the GNU General Public License
 122 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.