Clean up and document API for hashes
[p5sagit/p5-mst-13.2.git] / gv.h
diff --git a/gv.h b/gv.h
index c713f4e..8a8ac65 100644 (file)
--- a/gv.h
+++ b/gv.h
@@ -13,7 +13,7 @@ struct gp {
     struct io *        gp_io;          /* filehandle value */
     CV *       gp_form;        /* format value */
     AV *       gp_av;          /* array value */
-    HV *       gp_hv;          /* associative array value */
+    HV *       gp_hv;          /* hash value */
     GV *       gp_egv;         /* effective gv, if *glob */
     CV *       gp_cv;          /* subroutine value */
     U32                gp_cvgen;       /* generational validity of cached gv_cv */
@@ -42,7 +42,9 @@ struct gp {
 
 #define GvFORM(gv)     (GvGP(gv)->gp_form)
 #define GvAV(gv)       (GvGP(gv)->gp_av)
-#define GvREFCNT_inc(gv) ((GV*)SvREFCNT_inc(gv))
+
+/* This macro is deprecated.  Do not use! */
+#define GvREFCNT_inc(gv) ((GV*)SvREFCNT_inc(gv))       /* DO NOT USE */
 
 #ifdef MICROPORT       /* Microport 2.4 hack */
 AV *GvAVn();