changeset 4585:871eb054b34a

Document non-obvious usages.
author Stephen J. Turnbull <stephen@xemacs.org>
date Tue, 25 Nov 2008 10:44:16 +0900
parents 56e67d42eb04
children 6a6689b96f00
files src/ChangeLog src/elhash.c
diffstat 2 files changed, 11 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Thu Nov 20 23:59:52 2008 +0900
+++ b/src/ChangeLog	Tue Nov 25 10:44:16 2008 +0900
@@ -137,6 +137,13 @@
 	* input-method-xlib.c:
 	Use Xt_RESOURCE.
 
+2008-11-25  Stephen J. Turnbull  <stephen@xemacs.org>
+
+	* elhash.c (hash_table_data_validate):
+	* elhash.c (decode_hash_table_rehash_size):
+	* elhash.c (decode_hash_table_rehash_threshold):
+	Document side effects used in these functions.
+
 2008-11-20  Stephen J. Turnbull  <stephen@xemacs.org>
 
 	* console-x-impl.h (struct x_frame): Clarify comment.
--- a/src/elhash.c	Thu Nov 20 23:59:52 2008 +0900
+++ b/src/elhash.c	Tue Nov 25 10:44:16 2008 +0900
@@ -755,6 +755,7 @@
 static double
 decode_hash_table_rehash_size (Lisp_Object rehash_size)
 {
+  /* -1.0 signals make_general_lisp_hash_table to use the default. */
   return NILP (rehash_size) ? -1.0 : XFLOAT_DATA (rehash_size);
 }
 
@@ -786,6 +787,7 @@
 static double
 decode_hash_table_rehash_threshold (Lisp_Object rehash_threshold)
 {
+  /* -1.0 signals make_general_lisp_hash_table to use the default. */
   return NILP (rehash_threshold) ? -1.0 : XFLOAT_DATA (rehash_threshold);
 }
 
@@ -795,6 +797,7 @@
 {
   int len;
 
+  /* Check for improper lists while getting length. */
   GET_EXTERNAL_LIST_LENGTH (value, len);
 
   if (len & 1)
@@ -804,6 +807,7 @@
 	 value, Qhash_table, errb);
       return 0;
     }
+  
   return 1;
 }