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