Comment cleanup (#2689)

* Clean up content and redundant logging in comments.

1 files changed, 11 insertions, 40 deletions

diff --git a/src/H5Cprivate.h b/src/H5Cprivate.h
index 6a661d2..949c3e1 100644
--- a/src/H5Cprivate.h
+++ b/src/H5Cprivate.h
@@ -42,8 +42,6 @@
 /* This sanity checking constant was picked out of the air.  Increase
  * or decrease it if appropriate.  Its purposes is to detect corrupt
  * object sizes, so it probably doesn't matter if it is a bit big.
- *
- *                    JRM - 5/17/04
  */
 #define H5C_MAX_ENTRY_SIZE ((size_t)(32 * 1024 * 1024))
 
@@ -978,8 +976,6 @@ typedef int H5C_ring_t;
  *
  * The fields of this structure are discussed individually below:
  *
- *                        JRM - 4/26/04
- *
  * magic:    Unsigned 32 bit integer that must always be set to
  *              H5C__H5C_CACHE_ENTRY_T_MAGIC when the entry is valid.
  *              The field must be set to H5C__H5C_CACHE_ENTRY_T_BAD_MAGIC
@@ -1100,15 +1096,9 @@ typedef int H5C_ring_t;
  *           be unpinned (and possibly unprotected) during the
  *           flush.
  *
- *                               JRM -- 3/16/06
- *
  * in_slist:    Boolean flag indicating whether the entry is in the skip list
- *        As a general rule, entries are placed in the list when they
- *              are marked dirty.  However they may remain in the list after
- *              being flushed.
- *
- *              Update: Dirty entries are now removed from the skip list
- *            when they are flushed.
+ *        As a general rule, entries are placed in the list when they are
+ *        marked dirty.
  *
  * flush_marker:  Boolean flag indicating that the entry is to be flushed
  *        the next time H5C_flush_cache() is called with the
@@ -1116,24 +1106,13 @@ typedef int H5C_ring_t;
  *        the entry is flushed for whatever reason.
  *
  * flush_me_last:  Boolean flag indicating that this entry should not be
- *        flushed from the cache until all other entries without
- *              the flush_me_last flag set have been flushed.
- *
- *        Note:
+ *        flushed from the cache until all other entries without the
+ *        flush_me_last flag set have been flushed.
  *
- *        At this time, the flush_me_last
- *              flag will only be applied to one entry, the superblock,
- *              and the code utilizing these flags is protected with HDasserts
- *              to enforce this. This restraint can certainly be relaxed in
- *              the future if the need for multiple entries getting flushed
- *              last or collectively arises, though the code allowing for that
- *              will need to be expanded and tested appropriately if that
- *              functionality is desired.
- *
- *        Update: There are now two possible last entries
- *                       (superblock and file driver info message).  This
- *                       number will probably increase as we add superblock
- *                       messages.   JRM -- 11/18/14
+ *        Note: At this time, the flush_me_last flag will only be applied to
+ *              two types of entries: the superblock and the file driver info
+ *              message.  The code utilizing these flags is protected with
+ *              HDasserts to enforce this.
  *
  * clear_on_unprotect:  Boolean flag used only in PHDF5.  When H5C is used
  *        to implement the metadata cache In the parallel case, only
@@ -1228,8 +1207,6 @@ typedef int H5C_ring_t;
  * If there are multiple entries in any hash bin, they are stored in a doubly
  * linked list.
  *
- * Addendum:  JRM -- 10/14/15
- *
  * We have come to scan all entries in the cache frequently enough that
  * the cost of doing so by scanning the hash table has become unacceptable.
  * To reduce this cost, the index now also maintains a doubly linked list
@@ -1691,8 +1668,6 @@ typedef struct H5C_cache_entry_t {
  *
  * The fields of this structure are discussed individually below:
  *
- *                        JRM - 8/5/15
- *
  * magic:    Unsigned 32 bit integer that must always be set to
  *              H5C_IMAGE_ENTRY_T_MAGIC when the entry is valid.
  *              The field must be set to H5C_IMAGE_ENTRY_T_BAD_MAGIC
@@ -1855,7 +1830,7 @@ typedef struct H5C_image_entry_t {
  *    H5C_auto_size_ctl_t passed to the cache must have a known
  *    version number, or an error will be flagged.
  *
- * report_fcn:  Pointer to the function that is to be called to report
+ * rpt_fcn:  Pointer to the function that is to be called to report
  *    activities each time the auto cache resize code is executed.  If the
  *    field is NULL, no call is made.
  *
@@ -1978,10 +1953,6 @@ typedef struct H5C_image_entry_t {
  *      performance, however the above flash increment algorithm will not be
  *      triggered.
  *
- *      Hopefully, the add space algorithm detailed above will be sufficient
- *      for the performance problems encountered to date.  However, we should
- *      expect to revisit the issue.
- *
  * flash_multiple: Double containing the multiple described above in the
  *      H5C_flash_incr__add_space section of the discussion of the
  *      flash_incr_mode section.  This field is ignored unless flash_incr_mode
@@ -2048,8 +2019,8 @@ typedef struct H5C_image_entry_t {
  *    The field is a double containing the multiplier used to derive the
  *    new cache size from the old if a cache size decrement is triggered.
  *    The decrement must be in the range 0.0 (in which case the cache will
- *      try to contract to its minimum size) to 1.0 (in which case the
- *      cache will never shrink).
+ *    try to contract to its minimum size) to 1.0 (in which case the
+ *    cache will never shrink).
  *
  * apply_max_decrement:  Boolean flag used to determine whether decrements
  *    in cache size are to be limited by the max_decrement field.