[svn:parrot-pdd] r14308 - in trunk: . cage docs docs/art docs/dev docs/imcc docs/pdds docs/pdds/clip docs/stm languages languages/tcl/docs lib/Pod/Simple t/distro

Author: ambs
Date: Tue Aug 22 10:14:31 2006
New Revision: 14308

Modified:
   trunk/docs/pdds/clip/pdd06_pasm.pod
   trunk/docs/pdds/clip/pdd09_gc.pod
   trunk/docs/pdds/clip/pdd10_embedding.pod
   trunk/docs/pdds/clip/pdd11_extending.pod
   trunk/docs/pdds/pdd21_namespaces.pod

Changes in other areas also in this revision:
Modified:
   trunk/README.win32.pod
   trunk/cage/todo.pod
   trunk/docs/BROKEN.pod
   trunk/docs/art/pp002-pmc.pod
   trunk/docs/compiler_faq.pod
   trunk/docs/configuration.pod
   trunk/docs/debug.pod
   trunk/docs/dev/optimizer.pod
   trunk/docs/embed.pod
   trunk/docs/faq.pod
   trunk/docs/imcc/syntax.pod
   trunk/docs/intro.pod
   trunk/docs/optable.pod
   trunk/docs/stm/atomic.pod
   trunk/docs/stm/stm_frontend.pod
   trunk/docs/stm/thread-issues.pod
   trunk/docs/strings.pod
   trunk/docs/tests.pod
   trunk/docs/vtables.pod
   trunk/languages/LANGUAGES.STATUS.pod
   trunk/languages/tcl/docs/howto.pod
   trunk/lib/Pod/Simple/Subclassing.pod
   trunk/t/distro/linelength.t

Log:
While discussion continues on p2, pod files should be at most
80 columns, special on verbatim sections, so we the man formatter
show it properly.


Modified: trunk/docs/pdds/clip/pdd06_pasm.pod
==============================================================================
--- trunk/docs/pdds/clip/pdd06_pasm.pod	(original)
+++ trunk/docs/pdds/clip/pdd06_pasm.pod	Tue Aug 22 10:14:31 2006
@@ -58,12 +58,14 @@
 in a label a dollar sign can appear) are private to the subroutine they appear
 in.
 
-Namespaces are noted with the C<.namespace> directive. It takes a single parameter,
-the name of the namespace, in the form of a multi-dimensional key.
-
-Subroutine names are noted with the C<.sub> directive. It takes a single parameter,
-the name of the subroutine, which is added to the namespace's symbol table. Sub
-names may be any valid Unicode alphanumeric character and the underscore.
+Namespaces are noted with the C<.namespace> directive. It takes a
+single parameter, the name of the namespace, in the form of a
+multi-dimensional key.
+
+Subroutine names are noted with the C<.sub> directive. It takes a
+single parameter, the name of the subroutine, which is added to the
+namespace's symbol table. Sub names may be any valid Unicode
+alphanumeric character and the underscore.
 
 Constants don't need to be named and put in a separate section of the assembly
 source. The assembler will take care of putting them in the appropriate part of
@@ -1010,7 +1012,10 @@
 
 So the signature for, for example, this SDL routine:
 
-   int SDL_BlitSurface(SDL_Surface *src, SDL_Rect *srcrect, SDL_Surface *dst, SDL_Rect *dstrect);
+   int SDL_BlitSurface(SDL_Surface *src,
+                       SDL_Rect    *srcrect,
+                       SDL_Surface *dst,
+                       SDL_Rect    *dstrect);
 
 would be C<ipppp>, since it returns an integer and takes four pointers.
 Presumably previous calls would have set those pointers up properly.

Modified: trunk/docs/pdds/clip/pdd09_gc.pod
==============================================================================
--- trunk/docs/pdds/clip/pdd09_gc.pod	(original)
+++ trunk/docs/pdds/clip/pdd09_gc.pod	Tue Aug 22 10:14:31 2006
@@ -227,7 +227,8 @@
 This macro is invoked when in aggregate C<agg> the element C<old> is getting
 overritten by C<new>. Both C<old> and C<new> may be NULL.
 
-=item C<DOD_WRITE_BARRIER_KEY(Interp*, PMC *agg, PMC *old, PObj *old_key, PMC *new, PObj *new_key)>
+=item C<DOD_WRITE_BARRIER_KEY(Interp*, PMC *agg, PMC *old, PObj
+*old_key, PMC *new, PObj *new_key)>
 
 Like above. Invoked when a hash key is inserted, possibly replacing an old
 key.

Modified: trunk/docs/pdds/clip/pdd10_embedding.pod
==============================================================================
--- trunk/docs/pdds/clip/pdd10_embedding.pod	(original)
+++ trunk/docs/pdds/clip/pdd10_embedding.pod	Tue Aug 22 10:14:31 2006
@@ -7,7 +7,8 @@
 
 =head1 ABSTRACT
 
-What we believe people will do when embedding and extending Parrot, why they do it, and how.
+What we believe people will do when embedding and extending Parrot, why they
+do it, and how.
 
 {{ NOTE: some of this will later move into pdds 11 & 12, but for now
 just want to get the stub checked in. }}
@@ -19,45 +20,103 @@
 =head1 DESCRIPTION
 
 Why embed:
-	- access to special features/libraries/languages Parrot provides
-	- need an interpreter for a DSL or existing language
-	- want to run Parrot on another platform or environment (dedicated
-	  hardware, in a web server, et cetera)
+
+=over 4
+
+=item - access to special features/libraries/languages Parrot provides
+
+=item - need an interpreter for a DSL or existing language
+
+=item - want to run Parrot on another platform or environment (dedicated
+hardware, in a web server, et cetera)
+
+=back
 
 Why extend:
-	- need something NCI doesn't provide
-	- writing a custom PMC
+
+=over 4
+
+=item - need something NCI doesn't provide
+
+=item - writing a custom PMC
+
+=back
 
 Philosophical rules:
-	- only ever use opaque pointers
-	- should be able to communicate through PMCs
-	- minimize conversions to and from C data
-		- perhaps macros; Ruby does this fairly well and Perl 5 does this
-		  poorly
-		- minimize the number of necessary functions
-		- probably can follow core Parrot code to some extent, but beware the
-		  Perl 5 problem
-			- do not expose Parrot internals that may change
-			- probably includes vtable methods on PMCs
+
+=over 4
+
+=item - only ever use opaque pointers
+
+=item - should be able to communicate through PMCs
+
+=item - minimize conversions to and from C data
+
+=over 4
+
+=item - perhaps macros; Ruby does this fairly well and Perl 5 does this
+poorly
+
+=item - minimize the number of necessary functions
+
+=item - probably can follow core Parrot code to some extent, but beware the
+Perl 5 problem
+
+=over 4
+
+=item - do not expose Parrot internals that may change
+
+=item - probably includes vtable methods on PMCs
+
+=back
+
+=back
+
+=back
 
 Gotchas:
-	- who handles signals?
-	- who owns file descriptors and other Unix resources?
-	- is there an exception boundary?
-	- namespace issues -- especially key related
-	- probably a continuation/control flow boundary
-	- packfiles and compilation units probably too much information for either
-	- do not let MMD and other implementation details escape
-	- okay to require some PBC/PIR/PASM for handling round-trip data
-	- Parrot should not spew errors to STDERR when embedded
-	- const_string() is a real pain, especially with necessary deallocation
-	- should be access to Parrot's event loop when embedded
-	- passing var args to Parrot subs likely painful
-		- perhaps macros/functions to add parameters to call
-		- build up a call signature somehow?
-		- some abstraction for a call frame?
 
-	- compiling code from a string should return the PMC Sub entry point (:main)
+=over 4
+
+=item - who handles signals?
+
+=item - who owns file descriptors and other Unix resources?
+
+=item - is there an exception boundary?
+
+=item - namespace issues -- especially key related
+
+=item - probably a continuation/control flow boundary
+
+=item - packfiles and compilation units probably too much information for
+either
+
+=item - do not let MMD and other implementation details escape
+
+=item - okay to require some PBC/PIR/PASM for handling round-trip data
+
+=item - Parrot should not spew errors to STDERR when embedded
+
+=item - const_string() is a real pain, especially with necessary deallocation
+
+=item - should be access to Parrot's event loop when embedded
+
+=item - passing var args to Parrot subs likely painful
+
+=over 4
+
+=item - perhaps macros/functions to add parameters to call
+
+=item - build up a call signature somehow?
+
+=item - some abstraction for a call frame?
+
+=back
+
+=item - compiling code from a string should return the PMC Sub entry point
+(:main)
+
+=back
 
 =head1 DEFINITIONS
 

Modified: trunk/docs/pdds/clip/pdd11_extending.pod
==============================================================================
--- trunk/docs/pdds/clip/pdd11_extending.pod	(original)
+++ trunk/docs/pdds/clip/pdd11_extending.pod	Tue Aug 22 10:14:31 2006
@@ -144,7 +144,8 @@
 Keyed version of C<Parrot_PMC_set_pointer>. Assigns C<value> to the PMC stored 
 at element <key> of the passed-in PMC.
 
-=item C<Parrot_PMC_set_pmc_intkey(interp, pmc, Parrot_PMC value, Parrot_Int key)>
+=item C<Parrot_PMC_set_pmc_intkey(interp, pmc, Parrot_PMC value,
+Parrot_Int key)>
 
 Assigns C<value> to the PMC stored at element <key> of the passed-in PMC.
 

Modified: trunk/docs/pdds/pdd21_namespaces.pod
==============================================================================
--- trunk/docs/pdds/pdd21_namespaces.pod	(original)
+++ trunk/docs/pdds/pdd21_namespaces.pod	Tue Aug 22 10:14:31 2006
@@ -275,8 +275,8 @@
 
 This method allows other HLLs to know one name (the HLL) and then work with
 that HLL's modules without having to know the name it chose for its namespace
-tree.  (If you really want to know the name, the get_name() method should work on
-the returned namespace PMC.)
+tree.  (If you really want to know the name, the get_name() method should work
+on the returned namespace PMC.)
 
 Note that this method is basically a convenience and/or performance hack, as
 it does the equivalent of C<get_root_namespace> followed by
0
ambs
8/22/2006 5:14:34 PM
perl.perl6.internals 7376 articles. 0 followers. Follow

1 Replies
779 Views

Similar Articles

[PageSpeed] 45

--7Rldj+JZnTQmDdGi
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

I hope you didn't do that by hand.  I wrote a utility last Dec.
specifically for formatting Parrot's Pod.

    http://search.cpan.org/~jhoblitt/Pod-Tidy-0.09/

-J

--

--7Rldj+JZnTQmDdGi
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)

iD8DBQFE68btWa2BU+b7tU0RAss0AJ98MUUZbrZ3pyHbe3wUzTuLfmX37ACeMqXW
/h428Z4kBiaDdiYLqCpknyY=
=8n64
-----END PGP SIGNATURE-----

--7Rldj+JZnTQmDdGi--
0
jhoblitt
8/23/2006 3:09:33 AM
Reply:

Similar Artilces:

[svn:parrot-pdd] r20926
Author: chromatic Date: Thu Aug 30 14:25:32 2007 New Revision: 20926 Modified: trunk/docs/pdds/draft/pdd16_native_call.pod trunk/docs/pdds/draft/pdd17_pmc.pod trunk/docs/pdds/pdd03_calling_conventions.pod trunk/docs/pdds/pdd21_namespaces.pod trunk/docs/pdds/pdd22_io.pod Changes in other areas also in this revision: Modified: trunk/docs/art/pp002-pmc.pod trunk/docs/art/pp003-oop.pod trunk/docs/book/ch03_pir_basics.pod trunk/docs/book/ch05_pasm.pod trunk/docs/compiler_faq.pod trunk/docs/dev/jit_i386.pod trunk/docs/imcc/calling_conventions....

[svn:parrot-pdd] r26309
Author: allison Date: Tue Mar 11 02:50:21 2008 New Revision: 26309 Modified: trunk/docs/pdds/draft/pdd04_datatypes.pod trunk/docs/pdds/pdd17_pmc.pod Changes in other areas also in this revision: Added: trunk/lib/Parrot/Pmc2c/Attribute.pm - copied unchanged from r26307, /branches/pdd17pmc/lib/Parrot/Pmc2c/Attribute.pm trunk/tools/dev/vtablize.pl - copied unchanged from r26307, /branches/pdd17pmc/tools/dev/vtablize.pl Modified: trunk/MANIFEST trunk/compilers/bcg/src/pmc/bcg.pmc trunk/compilers/imcc/pbc.c trunk/config/auto/pmc.pm trunk/c...

[svn:parrot-pdd] r13183
Author: chip Date: Thu Jul 6 13:05:47 2006 New Revision: 13183 Modified: trunk/docs/pdds/pdd00_pdd.pod Changes in other areas also in this revision: Modified: trunk/README trunk/README.win32.pod trunk/RELEASE_INSTRUCTIONS trunk/compilers/imcc/README trunk/docs/debug.pod trunk/docs/dev/dod.pod trunk/docs/faq.pod trunk/docs/gettingstarted.pod trunk/docs/glossary.pod trunk/docs/intro.pod trunk/docs/parrot.pod trunk/docs/submissions.pod trunk/editor/pir-mode.el trunk/languages/regex/README trunk/languages/tcl/README.pod ...

[svn:parrot-pdd] r24056
Author: coke Date: Tue Dec 18 19:27:11 2007 New Revision: 24056 Modified: trunk/docs/pdds/draft/pdd08_keys.pod Changes in other areas also in this revision: Added: trunk/src/vtable.tbl - copied unchanged from r24055, /trunk/vtable.tbl Removed: trunk/vtable.tbl Modified: trunk/MANIFEST trunk/config/gen/makefiles/root.in trunk/docs/stm/internals.pod trunk/docs/vtables.pod trunk/lib/Parrot/Manifest.pm trunk/lib/Parrot/Pmc2c/Pmc2cMain.pm trunk/lib/Parrot/Vtable.pm trunk/src/pmc/default.pmc trunk/t/tools/pmc2cutils/03-dump_vtable.t ...

[svn:parrot-pdd] r16761
Author: particle Date: Mon Jan 22 11:29:00 2007 New Revision: 16761 Added: trunk/docs/pdds/draft/ - copied from r16760, /trunk/docs/pdds/clip/ Removed: trunk/docs/pdds/clip/ Modified: trunk/docs/pdds/README trunk/docs/pdds/draft/pdd24_events.pod trunk/docs/pdds/draft/pdd25_concurrency.pod Changes in other areas also in this revision: Modified: trunk/MANIFEST trunk/src/bignum.c trunk/src/bignum.h trunk/t/pmc/bignum.t Log: #41267: [TODO] rename 'clip' pdd directory to 'draft' ~ repo-wide rename of pdd 'clip' direc...

[svn:parrot-pdd] r32407
Author: coke Date: Thu Nov 6 14:41:14 2008 New Revision: 32407 Modified: trunk/docs/pdds/pdd19_pir.pod Changes in other areas also in this revision: Modified: trunk/DEPRECATED.pod trunk/compilers/imcc/imcc.y trunk/compilers/imcc/imcparser.c trunk/compilers/pct/src/POST/Compiler.pir trunk/docs/art/pp003-oop.pod trunk/docs/book/ch04_pir_subroutines.pod trunk/docs/book/ch05_pasm.pod trunk/t/compilers/imcc/syn/objects.t Log: RT #48549 [DEPRECATED] [PDD19] .namespace requires brackets Force .namespace to require brackets instead of allowing a bare ...

[svn:parrot-pdd] r28280
Author: Whiteknight Date: Thu Jun 12 12:34:51 2008 New Revision: 28280 Modified: trunk/docs/pdds/pdd09_gc.pod Changes in other areas also in this revision: Modified: trunk/compilers/imcc/main.c trunk/compilers/imcc/parser_util.c trunk/docs/book/ch02_getting_started.pod trunk/include/parrot/dod.h trunk/include/parrot/oo.h trunk/include/parrot/resources.h trunk/languages/dotnet/pmc/dotnetassembly.pmc trunk/languages/lua/src/pmc/lua.pmc trunk/languages/lua/src/pmc/luatable.pmc trunk/src/dynext.c trunk/src/exit.c trunk/src/gc/dod.c t...

[svn:parrot-pdd] r12841
Author: coke Date: Tue May 30 08:23:20 2006 New Revision: 12841 Modified: trunk/docs/pdds/clip/pdd22_io.pod trunk/docs/pdds/clip/pdd23_exceptions.pod trunk/docs/pdds/clip/pdd24_events.pod trunk/docs/pdds/clip/pdd25_threads.pod Changes in other areas also in this revision: Modified: trunk/Configure.pl trunk/compilers/imcc/imcparser.c trunk/debian/copyright trunk/lib/Parrot/Op.pm trunk/parrot-config trunk/parrotbug trunk/t/examples/streams.t trunk/tools/build/headerize.pl trunk/tools/build/jit2c.pl trunk/tools/build/nativecall.pl ...

[svn:parrot-pdd] r32356
Author: coke Date: Tue Nov 4 17:46:38 2008 New Revision: 32356 Modified: trunk/docs/pdds/pdd19_pir.pod Changes in other areas also in this revision: Modified: trunk/DEPRECATED.pod trunk/compilers/imcc/imc.h trunk/compilers/imcc/imcc.l trunk/compilers/imcc/imcc.y trunk/compilers/imcc/imclexer.c trunk/compilers/imcc/imcparser.c trunk/compilers/imcc/imcparser.h trunk/compilers/imcc/parser_util.c trunk/docs/book/ch13_reference.pod trunk/docs/imcc/imcfaq.pod trunk/editor/pir-mode.el Log: Remove .pragma n_operators, closing out RT #57438....

[svn:parrot-pdd] r35378
Author: allison Date: Sat Jan 10 19:55:39 2009 New Revision: 35378 Modified: trunk/docs/pdds/pdd09_gc.pod Changes in other areas also in this revision: Added: trunk/include/parrot/gc_api.h - copied unchanged from r35374, /branches/pdd09gc_part2/include/parrot/gc_api.h trunk/include/parrot/gc_mark_sweep.h - copied unchanged from r35374, /branches/pdd09gc_part2/include/parrot/gc_mark_sweep.h trunk/include/parrot/gc_pools.h - copied unchanged from r35374, /branches/pdd09gc_part2/include/parrot/gc_pools.h trunk/src/gc/api.c - copied unchange...

[svn:parrot-pdd] r22180
Author: allison Date: Wed Oct 17 12:33:17 2007 New Revision: 22180 Modified: trunk/docs/pdds/pdd15_objects.pod trunk/docs/pdds/pdd17_pmc.pod Changes in other areas also in this revision: Added: trunk/include/parrot/oo.h - copied unchanged from r22176, /branches/pdd15oo/include/parrot/oo.h trunk/include/parrot/oo_private.h - copied unchanged from r22176, /branches/pdd15oo/include/parrot/oo_private.h trunk/src/oo.c - copied unchanged from r22176, /branches/pdd15oo/src/oo.c trunk/t/oo/isa.t - copied unchanged from r22176, /branches/pdd1...

[svn:parrot-pdd] r14131
Author: creiss Date: Wed Aug 16 08:53:17 2006 New Revision: 14131 Modified: trunk/docs/pdds/clip/pdd10_embedding.pod trunk/docs/pdds/pdd23_exceptions.pod Changes in other areas also in this revision: Added: trunk/config/auto/cpu/ - copied from r14128, /branches/stm/config/auto/cpu/ trunk/config/auto/cpu.pm - copied unchanged from r14128, /branches/stm/config/auto/cpu.pm trunk/config/auto/cpu/i386/ - copied from r14128, /branches/stm/config/auto/cpu/i386/ trunk/config/auto/cpu/i386/auto.pm - copied unchanged from r14128, /branches/stm...

[svn:parrot-pdd] r26571
Author: coke Date: Wed Mar 26 19:35:50 2008 New Revision: 26571 Modified: trunk/docs/pdds/pdd23_exceptions.pod Changes in other areas also in this revision: Added: trunk/docs/book/appendix.pod (contents, props changed) Modified: trunk/DEPRECATED.pod trunk/MANIFEST trunk/PBC_COMPAT trunk/compilers/pirc/src/pirutil.c trunk/docs/book/ch08_reference.pod trunk/docs/compiler_faq.pod trunk/editor/pir-mode.el trunk/languages/PIR/src/pasm/pasm_instr.pg trunk/languages/PIR/src/pasm/pasm_pmc.pg trunk/src/ops/object.ops trunk/src/ops/ops.num ...

[svn:parrot-pdd] r31223
Author: tene Date: Thu Sep 18 01:47:46 2008 New Revision: 31223 Modified: trunk/docs/pdds/pdd19_pir.pod trunk/docs/pdds/pdd23_exceptions.pod Changes in other areas also in this revision: Modified: trunk/compilers/bcg/t/BCG.t trunk/compilers/pct/src/PAST/Compiler.pir trunk/compilers/pct/src/PCT/HLLCompiler.pir trunk/docs/compiler_faq.pod trunk/languages/APL/src/parser/actions.pm trunk/languages/WMLScript/src/wmlsstdlibs.pir trunk/languages/WMLScript/wmls2pbc.pir trunk/languages/WMLScript/wmls2pir.pir trunk/languages/WMLScript/wmlsd.pir tr...

Web resources about - [svn:parrot-pdd] r14308 - in trunk: . cage docs docs/art docs/dev docs/imcc docs/pdds docs/pdds/clip docs/stm languages languages/tcl/docs lib/Pod/Simple t/distro - perl.perl6.internals

Resources last updated: 11/29/2015 6:03:16 PM