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.
  19
  20 If 'make bootstrap' fails, it may be necessary to do 'make maintainer-clean'
  21 followed by configure before trying it again.
  22
  23 Normally, it is not necessary to use "make bootstrap" after every CVS
  24 update.  Unless there are problems, we suggest using the following
  25 alternative procedure after you have done "make bootstrap" at least
  26 once:
  27
  28   $ ./configure
  29   $ make
  30   $ cd lisp
  31   $ make recompile EMACS=../src/emacs
  32   $ cd ..
  33   $ make
  34
  35 (If you want to install the Emacs binary, type "make install" instead
  36 of "make" in the last command.)
  37
  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.  Another symptom may be an error saying that
  44 "loaddefs.el" could not be found; this is due to a change in the way
  45 loaddefs.el was handled in CVS, and should only happen once, for users
  46 that are updating old CVS trees.  Finally, sometimes there can be build
  47 failures related to *loaddefs.el (e.g. "required feature `esh-groups'
  48 was not provided").  In that case, follow the instructions below.
  49
  50 To update loaddefs.el (and similar files), do:
  51
  52   $ cd lisp
  53   $ make autogen-clean
  54   $ make autoloads EMACS=../src/emacs
  55
  56 If either of the above partial procedures fails, try "make bootstrap".
  57
  58 Very occasionally changes in the source can introduce
  59 incompatibilities with previous builds.  If a bootstrap fails, as a
  60 last resort try "make maintainer-clean" before configuring and
  61 bootstrapping again.  If CPU time is not an issue, the most thorough
  62 way to rebuild, and avoid any spurious problems, is always to use this
  63 method.
  64
  65 Users of non-Posix systems (MS-Windows etc.) should run the
  66 platform-specific configuration scripts (nt/configure.bat, config.bat,
  67 etc.) before "make bootstrap" or "make"; the rest of the procedure is
  68 applicable to those systems as well, except that the value of the
  69 EMACS variable on the Make command line might be different, e.g.,
  70 ../bin/emacs.exe or some such.
  71
  72 Questions, requests, and bug reports about the CVS versions of Emacs
  73 should be sent to emacs-pretest-bug@gnu.org rather than gnu.emacs.help
  74 or gnu.emacs.bug.  Ideally, use M-x report-emacs-bug RET which will
  75 send it to the proper place.
  76
  77
  78 Note on using SSH to access the CVS repository from inside Emacs
  79 ----------------------------------------------------------------
  80
  81 Write access to the CVS repository requires using SSH v2.
  82
  83 If you execute cvs commands inside Emacs, specifically if you use
  84 pcl-cvs, output from CVS may be lost due to a problem in the
  85 interface between ssh, cvs, and libc.  Corrupted checkins are
  86 also known to have happened.
  87
  88 To fix the problem, save the following script into a file, make it
  89 executable, and set CVS_RSH to the file name of the script:
  90
  91 #!/bin/bash
  92 exec 2> >(exec cat >&2 2>/dev/null)
  93 exec ssh "$@"
  94
  95 This may be combined with the following entry in ~/.ssh/config to
  96 simplify accessing the CVS repository:
  97
  98 Host subversions.gnu.org
  99      Protocol 2
 100      ForwardX11 no
 101      User YOUR_USERID
 102
 103 \f
 104 This file is part of GNU Emacs.
 105
 106 GNU Emacs is free software: you can redistribute it and/or modify
 107 it under the terms of the GNU General Public License as published by
 108 the Free Software Foundation, either version 3 of the License, or
 109 (at your option) any later version.
 110
 111 GNU Emacs is distributed in the hope that it will be useful,
 112 but WITHOUT ANY WARRANTY; without even the implied warranty of
 113 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 114 GNU General Public License for more details.
 115
 116 You should have received a copy of the GNU General Public License
 117 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.