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