annotate INSTALL.CVS @ 103273:c32ec20d0ab5

* abbrevs.texi (Abbrev Mode): abbrev-mode is an option. * backups.texi (Making Backups): backup-directory-alist and make-backup-file-name-function are options. (Auto-Saving): auto-save-list-file-prefix is an option. * buffers.texi (Killing Buffers): buffer-offer-save is an option. * display.texi (Refresh Screen): no-redraw-on-reenter is an option. (Echo Area Customization): echo-keystrokes is an option. (Selective Display): selective-display-ellipses is an option. (Temporary Displays): temp-buffer-show-function is an option. (Face Attributes): underline-minimum-offset and x-bitmap-file-path are options. (Font Selection): face-font-family-alternatives, face-font-selection-order, face-font-registry-alternatives, and scalable-fonts-allowed are options. (Fringe Indicators): indicate-buffer-boundaries is an option. (Fringe Cursors): overflow-newline-into-fringe is an option. (Scroll Bars): scroll-bar-mode is an option. * eval.texi (Eval): max-lisp-eval-depth is an option. * files.texi (Visiting Functions): find-file-hook is an option. (Directory Names): directory-abbrev-alist is an option. (Unique File Names): temporary-file-directory and small-temporary-file-directory are options. * frames.texi (Initial Parameters): initial-frame-alist, minibuffer-frame-alist and default-frame-alist are options. (Cursor Parameters): blink-cursor-alist and cursor-in-non-selected-windows ar options. (Window System Selections): selection-coding-system is an option. (Display Feature Testing): display-mm-dimensions-alist is an option. * help.texi (Help Functions): help-char and help-event-list are options. * keymaps.texi (Functions for Key Lookup): meta-prefix-char is an option. * minibuf.texi (Minibuffer History): history-length and history-delete-duplicates are options. (High-Level Completion): read-buffer-function and read-buffer-completion-ignore-case are options. (Reading File Names): read-file-name-completion-ignore-case is an option. * modes.texi (Mode Line Top): mode-line-format is an option. (Mode Line Variables): mode-line-position and mode-line-modes are options. * nonascii.texi (Text Representations): enable-multibyte-characters is an option. (Default Coding Systems): auto-coding-regexp-alist, file-coding-system-alist, auto-coding-alist and auto-coding-functions are options. (Specifying Coding Systems): inhibit-eol-conversion is an option. * os.texi (Init File): site-run-file is an option. (System Environment): mail-host-address is an option. (User Identification): user-mail-address is an option. (Terminal Output): baud-rate is an option. * positions.texi (Word Motion): words-include-escapes is an option. * searching.texi (Standard Regexps): page-delimiter, paragraph-separate, paragraph-separate and sentence-end are options. * text.texi (Margins): left-margin and fill-nobreak-predicate are options. * variables.texi (Local Variables): max-specpdl-size is an option. * windows.texi (Choosing Window): split-window-preferred-function, special-display-function and display-buffer-function are options.

Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
  Free Software Foundation, Inc.
See the end of the file for license conditions.


	      Building and Installing Emacs from CVS

If this is the first time you go through it, you'll need to configure
before bootstrapping:

  $ ./configure

Some of the files that are included in the Emacs tarball, such as
byte-compiled Lisp files, are not stored in the CVS repository.
Therefore, to build from CVS you must run "make bootstrap"
instead of just "make":

  $ cvs update -dP
  $ make bootstrap

Normally, it is not necessary to use "make bootstrap" after every CVS
update.  "make" should work in 90% of the cases and be much quicker.

  $ make

(If you want to install the Emacs binary, type "make install" instead
of "make" in the last command.)

Occasionally the file "lisp/loaddefs.el" (and similar automatically
generated files, such as esh-groups.el, and *-loaddefs.el in some
subdirectories of lisp/, e.g. mh-e/ and calendar/) will need to be
updated to reflect new autoloaded functions.  If you see errors (rather
than warnings) about undefined lisp functions during compilation, that
may be the reason.  Another symptom may be an error saying that
"loaddefs.el" could not be found; this is due to a change in the way
loaddefs.el was handled in CVS, and should only happen once, for users
that are updating old CVS trees.  Finally, sometimes there can be build
failures related to *loaddefs.el (e.g. "required feature `esh-groups'
was not provided").  In that case, follow the instructions below.

To update loaddefs.el (and similar files), do:

  $ cd lisp
  $ make autoloads

If either of the above partial procedures fails, try "make bootstrap".

Very occasionally changes in the source can introduce
incompatibilities with previous builds.  If a bootstrap fails, as a
last resort try "make maintainer-clean" before configuring and
bootstrapping again.  If CPU time is not an issue, the most thorough
way to rebuild, and avoid any spurious problems, is always to use this
method.

Users of non-Posix systems (MS-Windows etc.) should run the
platform-specific configuration scripts (nt/configure.bat, config.bat,
etc.) before "make bootstrap" or "make"; the rest of the procedure is
applicable to those systems as well.

Questions, requests, and bug reports about the CVS versions of Emacs
should be sent to [e-mail] rather than gnu.emacs.help
or gnu.emacs.bug.  Ideally, use M-x report-emacs-bug RET which will
send it to the proper place.

Because the CVS version of Emacs is a work in progress, it will
sometimes fail to build.  Please wait a day or so (and check the bug
and development mailing list archives) before reporting such problems.
In most cases, the problem is known about and is just waiting for
someone to fix it.


Note on using SSH to access the CVS repository from inside Emacs
----------------------------------------------------------------

Write access to the CVS repository requires using SSH v2.

If you execute cvs commands inside Emacs, specifically if you use
pcl-cvs, output from CVS may be lost due to a problem in the
interface between ssh, cvs, and libc.  Corrupted checkins are
also known to have happened.

To fix the problem, save the following script into a file, make it
executable, and set CVS_RSH to the file name of the script:

#!/bin/bash
exec 2> >(exec cat >&2 2>/dev/null)
exec ssh "$@"

This may be combined with the following entry in ~/.ssh/config to
simplify accessing the CVS repository:

Host subversions.gnu.org
     Protocol 2
     ForwardX11 no
     User YOUR_USERID


This file is part of GNU Emacs.

GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.