[AC21.5] Alphabetize ERROR_CHECK_*, sync configure docstring

Stephen J. Turnbull stephen at xemacs.org
Thu May 17 11:48:59 EDT 2007


APPROVE COMMIT 21.5

I doubt this will apply to 21.4, although a similar patch might be
useful.

configure will be regenerated and committed.

ChangeLog addition:

2007-05-18  Stephen J. Turnbull  <stephen at xemacs.org>

	* configure.ac (error-checking): Reorder arguments and sync doctring.


src/ChangeLog addition:

2007-05-18  Stephen J. Turnbull  <stephen at xemacs.org>

	* config.h.in (ERROR_CHECK_BYTE_CODE): Alphabetize ERROR_CHECK_*.


21.5 source patch:

Index: configure.ac
===================================================================
RCS file: /pack/xemacscvs/XEmacs/xemacs/configure.ac,v
retrieving revision 1.56
diff -u -u -r1.56 configure.ac
--- configure.ac	13 Mar 2007 16:48:38 -0000	1.56
+++ configure.ac	17 May 2007 15:11:51 -0000
@@ -979,20 +979,21 @@
 XE_MERGED_ARG([debug],
 	AS_HELP_STRING([--enable-debug],[Enable additional debugging information.  No time cost.]),
 	[], [])
+dnl Keep TESTS sorted to help with syncing doc to reality.
 XE_COMPLEX_ARG([error-checking],
 	AS_HELP_STRING([--enable-error-checking=TESTS],[Compile with internal error-checking added.
                         Causes noticeable loss of speed.  Valid TESTS
-                        are `extents', `bufpos', `malloc', `gc', `types', `text', `byte_code', `glyphs', `display', `structures'.]),
+                        are `byte_code', `display', `extents', `gc', `glyphs', `malloc', `structures' `text', `types'.]),
 	[], [],
-[XE_COMPLEX_OPTION([extents],[""]),
- XE_COMPLEX_OPTION([types],[""]),
- XE_COMPLEX_OPTION([text],[""]),
+[XE_COMPLEX_OPTION([byte_code],[""]),
+ XE_COMPLEX_OPTION([display],[""]),
+ XE_COMPLEX_OPTION([extents],[""]),
  XE_COMPLEX_OPTION([gc],[""]),
- XE_COMPLEX_OPTION([malloc],[""]),
- XE_COMPLEX_OPTION([byte_code],[""]),
  XE_COMPLEX_OPTION([glyphs],[""]),
- XE_COMPLEX_OPTION([display],[""]),
- XE_COMPLEX_OPTION([structures],[""])])
+ XE_COMPLEX_OPTION([malloc],[""]),
+ XE_COMPLEX_OPTION([structures],[""])
+ XE_COMPLEX_OPTION([text],[""]),
+ XE_COMPLEX_OPTION([types],[""]),])
 XE_MERGED_ARG([assertions],
 	AS_HELP_STRING([--enable-assertions],[Compile in runtime assertions.]),
 	[], [])
Index: src/config.h.in
===================================================================
RCS file: /pack/xemacscvs/XEmacs/xemacs/src/config.h.in,v
retrieving revision 1.111
diff -u -u -r1.111 config.h.in
--- src/config.h.in	15 Feb 2007 16:12:14 -0000	1.111
+++ src/config.h.in	17 May 2007 15:12:08 -0000
@@ -579,44 +579,47 @@
 
 /* Define one or more of the following if you want lots of extra checks
    (e.g. structure validation) compiled in.  These should be turned
-   on during the beta-test cycle. */
+   on during the beta-test cycle.
+
+   Keep macro names sorted to help with syncing this file to configure.ac.
+   Don't forget the ERROR_CHECK_ALL stuff at the end of this file. */
+
+/* Minor sanity checking of the bytecode interpreter.  Useful for
+   debugging the byte compiler.  */
+#undef ERROR_CHECK_BYTE_CODE
+
+/* Sanity-check the redisplay structures after each modification. */
+#undef ERROR_CHECK_DISPLAY
 
 /* Check the entire extent structure of a buffer each time an extent
    change is done, and do other extent-related checks. */
 #undef ERROR_CHECK_EXTENTS
 
-/* Turn on checks related to types -- make sure that all X... macros are
-   dereferencing the correct type, and that all XSET... macros (as much as
-   possible) are setting the correct type of structure; check any other
-   places that a specific type is expected. */
-#undef ERROR_CHECK_TYPES
-
-/* Turn on checks related to text -- check that text in strings and buffers
-   is in a valid format before we use it, check that buffer positions are
-   valid, etc. */
-#undef ERROR_CHECK_TEXT
-
 /* Attempt to catch bugs related to garbage collection (e.g. not GCPRO'ing). */
 #undef ERROR_CHECK_GC
 
-/* Attempt to catch freeing of a non-malloc()ed block, heap corruption, etc. */
-#undef ERROR_CHECK_MALLOC
-
-/* Minor sanity checking of the bytecode interpreter.  Useful for
-   debugging the byte compiler.  */
-#undef ERROR_CHECK_BYTE_CODE
-
 /* Minor sanity checking of glyphs, especially subwindows and
    widgets. */
 #undef ERROR_CHECK_GLYPHS
 
-/* Sanity-check the redisplay structures after each modification. */
-#undef ERROR_CHECK_DISPLAY
+/* Attempt to catch freeing of a non-malloc()ed block, heap corruption, etc. */
+#undef ERROR_CHECK_MALLOC
 
 /* Define for any sanity checks on structures that are not handled by a
    more specific error-checking type. */
 #undef ERROR_CHECK_STRUCTURES
 
+/* Turn on checks related to text -- check that text in strings and buffers
+   is in a valid format before we use it, check that buffer positions are
+   valid, etc. */
+#undef ERROR_CHECK_TEXT
+
+/* Turn on checks related to types -- make sure that all X... macros are
+   dereferencing the correct type, and that all XSET... macros (as much as
+   possible) are setting the correct type of structure; check any other
+   places that a specific type is expected. */
+#undef ERROR_CHECK_TYPES
+
 /* Define DEBUG_XEMACS if you want extra debugging code compiled in.
    This is mainly intended for use by developers. */
 #undef DEBUG_XEMACS
@@ -1132,16 +1135,19 @@
    merge the two. */
 #define USE_C_FONT_LOCK
 
+/* Keep the #defines sorted.
+   #### Can this code ever be executed?  I guess if a developer #defines
+   ERROR_CHECK_ALL above the #include it could be useful. */
 #ifdef ERROR_CHECK_ALL
+#define ERROR_CHECK_BYTE_CODE
+#define ERROR_CHECK_DISPLAY
 #define ERROR_CHECK_EXTENTS
-#define ERROR_CHECK_TYPES
-#define ERROR_CHECK_TEXT
 #define ERROR_CHECK_GC
-#define ERROR_CHECK_MALLOC
-#define ERROR_CHECK_BYTE_CODE
 #define ERROR_CHECK_GLYPHS
-#define ERROR_CHECK_DISPLAY
+#define ERROR_CHECK_MALLOC
 #define ERROR_CHECK_STRUCTURES
+#define ERROR_CHECK_TEXT
+#define ERROR_CHECK_TYPES
 #endif /* ERROR_CHECK_ALL */
 
 #endif /* _SRC_CONFIG_H_ */



More information about the XEmacs-Patches mailing list