cc-mode / README

Diff from to


-README for CC Mode 5.27
+README for CC Mode 5.28
 Current maintainer : Martin Stjernholm
 Contact address    :
     Please read the cc-mode.texi manual for details on using CC Mode.
     This is available on-line from:
-        <>
+        <>
-    As of this writing (22-Nov-1999), CC Mode version 5 currently
-    works out of the box with XEmacs versions 19.15, 19.16, 20.3,
-    20.4, 21.0, 21.1, and 21.2, and with Emacs versions 19.34, 20.2,
-    20.3, and 20.4.
+    As of this writing (February 25, 2001), CC Mode currently works
+    out of the box with XEmacs versions 19.15, 19.16, 20.3, 20.4,
+    21.0, 21.1, and 21.2, and with Emacs versions 19.34, 20.x, and
+    21.0.  (It very likely works with later versions too, when they
+    become available.)
     Here is a quick guide for installing CC Mode.  For the latest
-    information on installing CC Mode, including compatibility notes
-    for the various flavors of Emacs, please see the CC Mode web site
+    information on installing CC Mode, please see the CC Mode web site
     given above.
-  Setting load-path
-    You need to make sure that this new version of CC Mode is on your
-    load-path, before any version that is distributed with your
-    X/Emacs.  Note that the CC Mode distribution unpacks into its own
-    subdirectory.  You can use this test to see which version of CC
-    Mode your X/Emacs finds first:
-        M-x locate-library RET cc-mode RET
-    Make sure this finds the one you expect.  If not, you can add this
-    to your .emacs file:
-        (setq load-path (cons "/dir/of/cc-mode/" load-path))
-    The path you use should be an absolute path (starting with a
-    slash).  You cannot use a path beginning with "~" in the load-path
-    variable.
   Byte Compiling
     It is highly recommended that you byte-compile CC Mode, for both
     performance and compatibility reasons.  Running CC Mode
     un-bytecompiled is not supported and may not work at all depending
-    on the flavor of X/Emacs you are using.
+    on the flavor of (X)Emacs you are using.
-    To compile CC Mode, do the following from your shell:
+    You can compile CC Mode in the same way as any other package.  To
+    compile it from a running (X)Emacs session:
+        M-0 M-x byte-recompile-directory RET /path/to/cc-mode RET
+    To compile CC Mode from the shell:
         % cd /path/to/cc-mode
-        % $(EMACS) -batch -no-site-file -q -l cc-make.el cc-*.el
+        % $(EMACS) -batch -q -f batch-byte-compile cc-*.el
     where $(EMACS) is either emacs or xemacs depending on the flavor
     you use.
-    You can safely ignore any byte compiler warnings; they are due to
-    the cross X/Emacsen support.
+    If you compile with XEmacs 19, you'll get a lot of warnings.  They
+    can safely be ignored.
-    Note: It is important that CC Mode is byte compiled in the correct
-    way.  Avoid compiling from inside an X/Emacs session, since that
-    can produce incorrect byte code files that will generate strange
-    errors later during normal use.
+  Installing
-    Be sure to see the list of compatibility issues (in the CC Mode
-    canonical web pages -- see above), for special notes about X/Emacs
-    versions and package interactions.
+    Put the compiled files somewhere (X)Emacs will find them, i.e. in
+    some path that's in the load-path variable.  You must make sure
+    they are found before any CC Mode files which are distributed with
+    (X)Emacs.  A directory have higher precendence than all
+    directories after it in the load-path list.
     To test that you have things set up correctly, visit a C file and
     then type:
         => Using CC Mode version 5.XX
     where XX is the correct minor revision number.
+  Compatibility Issues
+    CC Mode should work fine with most versions of Emacs and XEmacs
+    which aren't ancient (see the introduction above).
+    However, in Emacs 19.34 the Custom library doesn't work with CC
+    Mode, so the customizable variables support won't be compiled in
+    there.  You need to get a later Custom library and make sure it's
+    loaded when CC Mode is compiled to enable it.
+    For more details about interactions with different packages, see
+    the CC Mode web page.