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