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