Fix gc_backptr.h, gc_mark.h, GC_DS_TAGS names in documentation
authorIvan Maidanski <ivmai@mail.ru>
Wed, 11 Jan 2017 08:26:11 +0000 (11:26 +0300)
committerIvan Maidanski <ivmai@mail.ru>
Wed, 11 Jan 2017 08:26:11 +0000 (11:26 +0300)
* doc/debugging.html: Rename backptr.h to gc_backptr.h.
* include/gc_mark.h (GC_DS_PER_OBJECT): Rename DS_TAGS to GC_DS_TAGS in
the comment.
* include/private/gc_priv.h (hblkhdr.hb_descr): Rename mark.h to
gc_mark.h in the comment.

doc/debugging.html
include/gc_mark.h
include/private/gc_priv.h

index 0128129..5c24862 100644 (file)
@@ -160,7 +160,7 @@ before including <TT>gc.h</tt> and allocating with <TT>GC_MALLOC</tt>),
 so that objects will be identified by their allocation site,
 <LI> Running the application long enough so
 that most of the heap is composed of "leaked" memory, and
-<LI> Then calling <TT>GC_generate_random_backtrace()</tt> from backptr.h
+<LI> Then calling <TT>GC_generate_random_backtrace()</tt> from gc_backptr.h
 a few times to determine why some randomly sampled objects in the heap are
 being retained.
 </ol>
index 7324abd..c30da2c 100644 (file)
@@ -101,10 +101,10 @@ typedef struct GC_ms_entry * (*GC_mark_proc)(GC_word * /* addr */,
                | (proc_index)) << GC_DS_TAG_BITS) | GC_DS_PROC)
 #define GC_DS_PER_OBJECT 3  /* The real descriptor is at the            */
                         /* byte displacement from the beginning of the  */
-                        /* object given by descr & ~DS_TAGS             */
+                        /* object given by descr & ~GC_DS_TAGS.         */
                         /* If the descriptor is negative, the real      */
                         /* descriptor is at (*<object_start>) -         */
-                        /* (descr & ~DS_TAGS) - GC_INDIR_PER_OBJ_BIAS   */
+                        /* (descr&~GC_DS_TAGS) - GC_INDIR_PER_OBJ_BIAS  */
                         /* The latter alternative can be used if each   */
                         /* object contains a type descriptor in the     */
                         /* first word.                                  */
index 71c8a20..417092d 100644 (file)
@@ -1001,7 +1001,7 @@ struct hblkhdr {
                    /* without generating a negative result.  We avoid    */
                    /* generating free blocks larger than that.           */
     word hb_descr;              /* object descriptor for marking.  See  */
-                                /* mark.h.                              */
+                                /* gc_mark.h.                           */
 #   ifdef MARK_BIT_PER_GRANULE
       unsigned short * hb_map;  /* Essentially a table of remainders    */
                                 /* mod BYTES_TO_GRANULES(hb_sz), except */