[PATCH 1/4] libgst: Fix comments

2017-04-26  Lee Duhem  <[email protected]>

       * byte.h: Fix typo in comments.
       * dict.h: Improve comments.
       * dict.c (new_num_fields): Ditto.
       * gst.h: Ditto.
       * sysdep.h: Ditto.
---
 libgst/ChangeLog | 8 ++++++++
 libgst/byte.h    | 2 +-
 libgst/dict.c    | 4 ++--
 libgst/dict.h    | 8 ++++----
 libgst/gst.h     | 2 +-
 libgst/oop.h     | 5 +----
 libgst/sysdep.h  | 2 +-
 7 files changed, 18 insertions(+), 13 deletions(-)

diff --git a/libgst/ChangeLog b/libgst/ChangeLog
index 5daf52b..d8e413c 100644
--- a/libgst/ChangeLog
+++ b/libgst/ChangeLog
@@ -1,3 +1,11 @@
+2017-04-26  Lee Duhem  <[email protected]>
+
+	* byte.h: Fix typo in comments.
+	* dict.h: Improve comments.
+	* dict.c (new_num_fields): Ditto.
+	* gst.h: Ditto.
+	* sysdep.h: Ditto.
+
 2016-12-30  Lee Duhem  <[email protected]>
 
 	* byte.c (_gst_compile_bytecodes): Subtract the free space.
diff --git a/libgst/byte.h b/libgst/byte.h
index 08e8bcb..78ecd9e 100644
--- a/libgst/byte.h
+++ b/libgst/byte.h
@@ -131,7 +131,7 @@ enum {
   LN_FORCE = 1,
 
   /* If LN_ABSOLUTE is also set, causes _gst_line_number to emit an absolute
-     ine number and use that line number as the offset.  If not,
+     line number and use that line number as the offset.  If not,
      _gst_line_number will emit line numbers relatives to that line.  */
   LN_RESET = 2,
 
diff --git a/libgst/dict.c b/libgst/dict.c
index 8b37f0f..517bd5d 100644
--- a/libgst/dict.c
+++ b/libgst/dict.c
@@ -197,7 +197,7 @@ static size_t new_num_fields (size_t oldNumFields);
 
 /* Instantiate the OOPs that are created before the first classes
    (true, false, nil, the Smalltalk dictionary, the symbol table
-   and Processor, the sole instance of ProcessorScheduler.  */
+   and Processor, the sole instance of ProcessorScheduler).  */
 static void init_proto_oops (void);
 
 /* Look for the index at which KEYOOP resides in IDENTITYDICTIONARYOOP
@@ -211,7 +211,7 @@ static ssize_t identity_dictionary_find_key (OOP identityDictionaryOOP,
 static size_t identity_dictionary_find_key_or_nil (OOP identityDictionaryOOP,
 						   OOP keyOOP);
 
-/* assume the value is an integer already or key does not exist, increase the
+/* Assume the value is an integer already or key does not exist, increase the
    value by inc or set the value to inc */
 static int _gst_identity_dictionary_at_inc (OOP identityDictionaryOOP,
                                             OOP keyOOP,
diff --git a/libgst/dict.h b/libgst/dict.h
index 5aaa7eb..303cc56 100644
--- a/libgst/dict.h
+++ b/libgst/dict.h
@@ -468,14 +468,14 @@ extern OOP _gst_class_variable_dictionary (OOP class_oop)
   ATTRIBUTE_PURE 
   ATTRIBUTE_HIDDEN;
 
-/* This finds the key SYMBOL into the dictionary POOLOOP and, if any,
+/* This finds the key SYMBOL in the dictionary POOLOOP and, if any,
    in all of its super-namespaces.  Returns the association.  */
 extern OOP _gst_namespace_association_at (OOP poolOOP,
 					  OOP symbol)
   ATTRIBUTE_PURE 
   ATTRIBUTE_HIDDEN;
 
-/* This finds the key SYMBOL into the dictionary POOLOOP and, if any,
+/* This finds the key SYMBOL in the dictionary POOLOOP and, if any,
    in all of its super-namespaces.  Returns the value.  */
 extern OOP _gst_namespace_at (OOP poolOOP,
 			      OOP symbol)
@@ -517,7 +517,7 @@ extern OOP _gst_find_class (OOP classNameOOP)
   ATTRIBUTE_PURE 
   ATTRIBUTE_HIDDEN;
 
-/* Look for an implementation of SELECTOR (a Symbol) into CLASS_OOP's
+/* Look for an implementation of SELECTOR (a Symbol) in CLASS_OOP's
    method dictionary or in the method dictionary of a superclass.  */
 extern OOP _gst_find_class_method (OOP class_oop,
 				   OOP selector)
@@ -647,7 +647,7 @@ extern void _gst_free_cobject (OOP cObjOOP)
   ATTRIBUTE_HIDDEN;
 
 /* Loads the contents of the global variables from the Smalltalk dictionary
-   after an image has been restored.  PRIM_TABLE_MATCHES if true if the
+   after an image has been restored.  PRIM_TABLE_MATCHES is true if the
    table of primitives is already set up correctly.  */
 extern mst_Boolean _gst_init_dictionary_on_image_load (mst_Boolean prim_table_matches) 
   ATTRIBUTE_HIDDEN;
diff --git a/libgst/gst.h b/libgst/gst.h
index da81618..a6906e9 100644
--- a/libgst/gst.h
+++ b/libgst/gst.h
@@ -176,7 +176,7 @@ struct object_s
 #define IS_OOP(oop) \
   (! IS_INT(oop) )
 
-/* Keep these in sync with _gst_sizes, in dict.c.
+/* Keep these in sync with _gst_log2_sizes, in dict.c.
    FIXME: these should be exported in a pool dictionary.  */
 enum gst_indexed_kind {
   GST_ISP_FIXED = 0,
diff --git a/libgst/oop.h b/libgst/oop.h
index 76a5977..efc51da 100644
--- a/libgst/oop.h
+++ b/libgst/oop.h
@@ -412,10 +412,7 @@ extern gst_object _gst_alloc_words (size_t size)
   ATTRIBUTE_HIDDEN;
 
 /* Grows the allocated memory to SPACESIZE bytes, if it's not there
-   already.  
-   the memory could not be allocated.  Should be called after the
-   sweep has occurred so that things are contiguous.  Ensures that the
-   OOP table pointers are fixed up to point to the new objects.  */
+   already. */
 extern void _gst_grow_memory_to (size_t size) 
   ATTRIBUTE_HIDDEN;
 
diff --git a/libgst/sysdep.h b/libgst/sysdep.h
index 5648ef2..65e7e97 100644
--- a/libgst/sysdep.h
+++ b/libgst/sysdep.h
@@ -153,7 +153,7 @@ extern uint64_t _gst_get_ns_time (void)
 extern time_t _gst_get_time (void)
   ATTRIBUTE_HIDDEN;
 
-/* Returns whether FILE1 is newer (or last modified at the same time as)
+/* Returns whether FILE1 is newer than (or last modified at the same time as)
    FILE2.  Returns true if FILE2 is not readable, false if FILE1 is not
    readable.  */
 extern mst_Boolean _gst_file_is_newer (const char *file1, const char *file2)
-- 
2.9.3