APPROVE COMMIT 21.5
Robert Royar writes:
I have made some corrections (to minor word forms and version
numbers)
in the new INSTALL file. The patch is included for INSTALL and
CHANGELOG.
Thank you, Robert! I didn't actually read much past the section
titles. ;-)
I read one section where more detail would help, but I do
not know the detail to add. In "Specifying Location of Headers and
Libraries" the --with-site-runtime-libraries explanation states that
multiple directories can be added to the search path; however, it does
not specify the format of that list.
As you guessed, the same code is used for processing all these lists.
I added a paragraph to that effect.
In the section "Advanced Make" the default for datadir is
listed as
/usr/local/data. This does not seem to be correct on all systems.
As Sean pointed out, this is a 21.5 improvement (ie, FHS compatibility).
I changed references to version numbers at various places in the file
Good idea. I fixed the syntax of betas (21.5-b32) and added the
patchlevel for the stable line.
Consider whether the section "Selecting configure Options"
should
include a forward reference to "Appendix: Correspondence to Old
configure Options." The list of removed options and enable/with
modifiers could be useful. I suggest moving the last paragraph of
"Random Notes" into the "Selecting configure Options" section.
Postponed to issue849.
I am not certain of the style for some nomenclature. I cannot tell
whether the document should always to refer to the file `configure' in
all lower case or to let that float.
I put section titles in upper case, text uses in lower case, and
references to section titles in title case.
# HG changeset patch
# Parent 6b027725e3401176451d62ba5e86de32bc38c6d6
More corrections to INSTALL by Robert Royer.
diff -r 6b027725e340 -r 37b107e878b8 ChangeLog
--- a/ChangeLog Fri Dec 28 02:29:16 2012 +0900
+++ b/ChangeLog Fri Dec 28 12:35:44 2012 +0900
@@ -1,3 +1,13 @@
+2012-12-27 Robert D. Royar <xemacs(a)royar.org>
+
+ Minor additions by Stephen J. Turnbull <stephen(a)xemacs.org>.
+
+ * INSTALL: correct typographical errors; update
+ version numbers provided in Running Make section;
+ change default datadir reference to /usr/local/share
+ to match all other references to datadir's subdirectories;
+ change "can not" to "cannot".
+
2012-11-04 Stephen J. Turnbull <stephen(a)xemacs.org>
* INSTALL: Reorganize and update.
diff -r 6b027725e340 -r 37b107e878b8 INSTALL
--- a/INSTALL Fri Dec 28 02:29:16 2012 +0900
+++ b/INSTALL Fri Dec 28 12:35:44 2012 +0900
@@ -28,8 +28,8 @@
Modern systems generally have more than enough RAM and virtual memory to run
XEmacs well. If you run into an "insufficient memory" error when building
-or on the first execution, see the 'PROBLEMS' file. In sufficient stack
-space is a separate problem, also address in 'PROBLEMS'.
+or on the first execution, see the 'PROBLEMS' file. Insufficient stack
+space is a separate problem, also addressed in 'PROBLEMS'.
Building XEmacs requires about 100 Mb of disk space (including the XEmacs
sources). Once installed, XEmacs occupies about 200 MB in the file system
@@ -136,7 +136,7 @@
doesn't seem to have all the corresponding features, check with the newsgroup
'comp.emacs.xemacs' or the mailing list 'xemacs-beta(a)xemacs.org'.
-SELECTING configure OPTIONS
+SELECTING CONFIGURE OPTIONS
===========================
Options are generally of the form `--with-FEATURE' to use a feature or
@@ -402,7 +402,7 @@
`/usr/local/share/xemacs-VERSION/lisp' holds the basic Emacs Lisp libraries
(including core implementations of many Lisp primitives);
`VERSION' stands for the number of the XEmacs version
- you are installing, like `19.14' or `21.5.31'. Since
+ you are installing, like `21.4.22' or `21.5-b32'. Since
the lisp libraries change from one version of XEmacs to
another, including the version number in the path
allows you to have several versions of XEmacs installed
@@ -500,7 +500,7 @@
========
The most common problem is that you forgot to read and follow the directions
-for installing bootstrap packages in the FAQ. You can not have a normal
+for installing bootstrap packages in the FAQ. You cannot have a normal
XEmacs without downloading some additional packages.
See the file PROBLEMS in this directory for a list of various problems
@@ -760,17 +760,19 @@
`datadir' indicates where to put the architecture-independent
read-only data files that XEmacs refers to while it runs; it
- defaults to /usr/local/data. We create the following
+ defaults to /usr/local/share. We create the following
subdirectories under `datadir':
+
- `xemacs-VERSION/lisp', containing the XEmacs lisp libraries, and
- `xemacs-VERSION/etc', containing the XEmacs tutorial and the
`yow' database.
+
`VERSION' is the number of the XEmacs version you are installing,
- like `18.59' or `19.14'. Since these files vary from one version
- of XEmacs to another, including the version number in the path
- allows you to have several versions of XEmacs installed at the
- same time; this means that you don't have to make XEmacs
+ like `21.4.22' or `21.5-b32'. Since these files vary from one
+ version of XEmacs to another, including the version number in the
+ path allows you to have several versions of XEmacs installed at
+ the same time; this means that you don't have to make XEmacs
unavailable while installing a new version.
`datarootdir' indicates where to put the documentation. (Usually,
@@ -884,7 +886,7 @@
in the subdirectories.
Using GNU Make allows for simultaneous builds with and without the --srcdir
-option.
+option (see the section Running Configure).
MAIL LOCKING
============
@@ -1177,6 +1179,10 @@
configuration changes. Not all systems need this option; it's best to avoid
using it if you can.
+To specify multiple directories in these commands, use a list delimited by
+spaces, colons, or commas. You will need to protect space-delimited lists
+from shell parsing by quoting them.
+
If you haven't built XEmacs 21.5 recently, the change from the configure
script based on Autoconf 2.13 can be a shock. Appendix: Correspondence to
Old Configure Options (at the end of this document) contains a list of old
_______________________________________________
XEmacs-Beta mailing list
XEmacs-Beta(a)xemacs.org
http://lists.xemacs.org/mailman/listinfo/xemacs-beta