[svn:parrot] r40850 - in trunk/docs: . pdds

[dukeleto at svn.parrot.org]

Author: dukeleto
Date: Sat Aug 29 06:43:55 2009
New Revision: 40850
URL: https://trac.parrot.org/parrot/changeset/40850

Log:
[t] Update docs regards building parrot_debugger and that UnionVal has been removed from the PMC struct, jrtayloriv++

Modified:
   trunk/docs/debugger.pod
   trunk/docs/pdds/pdd17_pmc.pod

Modified: trunk/docs/debugger.pod
==============================================================================
--- trunk/docs/debugger.pod	Sat Aug 29 05:01:08 2009	(r40849)
+++ trunk/docs/debugger.pod	Sat Aug 29 06:43:55 2009	(r40850)
@@ -20,17 +20,16 @@
 required to read this document. Some familiarity with debugging principles is
 also mandatory beyond this point.
 
+
 =head1 BUILDING parrot_debugger
 
-The debugger is not built with Parrot, but you should make it with its specific
-target:
+The debugger is built along with Parrot when you run 'make', but if you want to build 
+*only* the debugger, then you can run:
 
   make parrot_debugger
 
-(where C<make> is the same C<make> incarnation you used to build Parrot).
-
-If everything goes well, you should come up with a F<parrot_debugger>
-executable in the same directory as the Parrot program.
+Which will create a new parrot_debugger executable in the same directory as the parrot
+executable.
 
 =head1 THE DEBUGGER SHELL
 

Modified: trunk/docs/pdds/pdd17_pmc.pod
==============================================================================
--- trunk/docs/pdds/pdd17_pmc.pod	Sat Aug 29 05:01:08 2009	(r40849)
+++ trunk/docs/pdds/pdd17_pmc.pod	Sat Aug 29 06:43:55 2009	(r40850)
@@ -44,39 +44,13 @@
 All PMCs have the form:
 
     struct PMC {
-        UnionVal cache;
         Parrot_UInt flags;
         VTABLE *vtable;
         DPOINTER *data;
         PMC *_metadata;
-        struct _Sync *_synchronize; # [Note: may be deprecated, see STM]
+        struct _Sync *_synchronize;    # [Note: may be deprecated, see STM]
         PMC *_next_for_GC;
-    };
-
-where C<cache> is a C<UnionVal> union:
-
-    typedef union UnionVal {
-        struct {
-            void  *_bufstart;
-            size_t _buflen;
-        } _b;
-        struct {
-            DPOINTER *_struct_val;
-            PMC      *_pmc_val;
-        } _ptrs;
-        struct _i {
-            INTVAL _int_val;
-            INTVAL _int_val2;
-        } _i;
-        FLOATVAL _num_val;
-        struct parrot_string_t * _string_val;
-    } UnionVal;
-
-C<u> holds data associated with the PMC. This can be in the form of an integer
-value, a floating-point value, a string value, or a pointer to other data.
-C<u> may be empty, since the PMC structure also provides a more general data
-pointer, but is useful for PMCs which hold only a single piece of data (e.g.
-C<PerlInts>).
+    }
 
 C<flags> holds a set of flags associated with the PMC; these are documented
 in F<include/parrot/pobj.h>, and are generally only used within the Parrot
@@ -90,8 +64,8 @@
 C<data> holds a pointer to the core data associated with the PMC. This
 may be null.
 
-C<_metadata> holds internal PMC metadata. The specification for this has not
-yet been finalized.
+C<_metadata> holds internal PMC metadata (properties). See the setprop/getprop
+ops in F<docs/ops/pmc.pod>.
 
 C<_synchronize> is for access synchronization between shared PMCs.