# New Ticket Created by  chromatic 
# Please include the string:  [perl #31065]
# in the subject line of all future correspondence about this issue. 
# <URL: http://rt.perl.org:80/rt3/Ticket/Display.html?id=31065 >


Here's a patch that cleans up some POD errors and warnings in C files.

-- c


Index: src/inter_run.c
===================================================================
RCS file: /cvs/public/parrot/src/inter_run.c,v
retrieving revision 1.6
diff -u -u -r1.6 inter_run.c
--- src/inter_run.c	23 Jul 2004 13:26:32 -0000	1.6
+++ src/inter_run.c	11 Aug 2004 23:27:01 -0000
@@ -306,7 +306,7 @@
 /*
 
 =item C<void
-mark_saved_regs(Parrot_Interp interpreter)
+mark_saved_regs(Parrot_Interp interpreter)>
 
 Mark saved register aread live during DOD
 
@@ -351,10 +351,11 @@
 
 =item C<void
 Parrot_run_meth_fromc_save(Parrot_Interp, PMC *sub, PMC *obj, STRING *meth)>
-=cut
 
 Run a method sub from C.
 
+=cut
+
 */
 
 void
Index: src/lexical.c
===================================================================
RCS file: /cvs/public/parrot/src/lexical.c,v
retrieving revision 1.2
diff -u -u -r1.2 lexical.c
--- src/lexical.c	20 Jun 2004 10:31:38 -0000	1.2
+++ src/lexical.c	11 Aug 2004 23:27:02 -0000
@@ -17,6 +17,8 @@
 
 =over 4
 
+=cut
+
 */
 
 #include "parrot/parrot.h"
Index: src/pmc.c
===================================================================
RCS file: /cvs/public/parrot/src/pmc.c,v
retrieving revision 1.86
diff -u -u -r1.86 pmc.c
--- src/pmc.c	10 Jul 2004 15:30:56 -0000	1.86
+++ src/pmc.c	11 Aug 2004 23:27:03 -0000
@@ -51,7 +51,7 @@
 
 =item C<PMC *
 pmc_reuse(Interp *interpreter, PMC *pmc, INTVAL new_type,
-          UINTVAL flags)
+          UINTVAL flags)>
 
 Reuse an existing PMC, turning it into an empty PMC of the new
 type. Any required internal structure will be put in place (such as
@@ -611,7 +611,7 @@
 
 F<include/parrot/vtable.h>.
 
-<[EMAIL PROTECTED]>
+C<[EMAIL PROTECTED]>
 (http://www.nntp.perl.org/group/perl.perl6.internals/5516).
 
 =head1 HISTORY
Index: src/resources.c
===================================================================
RCS file: /cvs/public/parrot/src/resources.c,v
retrieving revision 1.126
diff -u -u -r1.126 resources.c
--- src/resources.c	9 Aug 2004 14:51:13 -0000	1.126
+++ src/resources.c	11 Aug 2004 23:27:03 -0000
@@ -92,15 +92,12 @@
 
 Allocates memory for headers.
 
-Alignment problems:  C<align_1> sets the size, but not the alignment of
-the memory block we are about to allocate.  The alignment of I<this>
-block is currently determined by the C<align_1> sent in by the
-I<previous> allocation. See
-L<http://archive.develooper.com/perl6-internals%40perl.org/msg12310.html
-> for details. Currently, we work around it by forcing all the
-C<*ALIGNMENT> C<#define>s in F<<include/parrot/<file>.h>> to be the
-same.
-
+Alignment problems:  C<align_1> sets the size, but not the alignment of the
+memory block we are about to allocate.  The alignment of I<this> block is
+currently determined by the C<align_1> sent in by the I<previous> allocation.
+See L<http://archive.develooper.com/perl6-internals%40perl.org/msg12310.html>
+for details. Currently, we work around it by forcing all the C<*ALIGNMENT>
+C<#define>s in F<E<lt>include/parrot/I<file>.hE<gt>> to be the same.
 
 =cut
 
Index: src/stack_common.c
===================================================================
RCS file: /cvs/public/parrot/src/stack_common.c,v
retrieving revision 1.18
diff -u -u -r1.18 stack_common.c
--- src/stack_common.c	7 Jul 2004 11:02:29 -0000	1.18
+++ src/stack_common.c	11 Aug 2004 23:27:03 -0000
@@ -24,18 +24,6 @@
 #include "parrot/parrot.h"
 #include <assert.h>
 
-
-/*
-
-=item C<void stack_system_init(Interp *interpreter)>
-
-Called from C<make_interpreter()> to initialize the interpreter's
-register stacks.
-
-=cut
-
-*/
-
 typedef struct {
     size_t size;
     Stack_Chunk_t *free_list;
@@ -51,7 +39,8 @@
 
 =item C<void stack_system_init(Interp *interpreter)>
 
-Initialize the stack subsystem
+Called from C<make_interpreter()> to initialize the interpreter's
+register stacks.
 
 =cut
 
Index: src/string.c
===================================================================
RCS file: /cvs/public/parrot/src/string.c,v
retrieving revision 1.214
diff -u -u -r1.214 string.c
--- src/string.c	10 Aug 2004 11:05:11 -0000	1.214
+++ src/string.c	11 Aug 2004 23:27:04 -0000
@@ -16,10 +16,6 @@
 two data members, beside setting C<bufstart>/C<buflen> for external
 strings.
 
-=head2 Functions
-
-=over 4
-
 =cut
 
 */
@@ -51,8 +47,6 @@
 
 /*
 
-=back
-
 =head2 String COW support
 
 =over 4
Index: src/warnings.c
===================================================================
RCS file: /cvs/public/parrot/src/warnings.c,v
retrieving revision 1.23
diff -u -u -r1.23 warnings.c
--- src/warnings.c	23 Apr 2004 09:21:13 -0000	1.23
+++ src/warnings.c	11 Aug 2004 23:27:04 -0000
@@ -10,7 +10,7 @@
 
 Parrot C<STRING> and C string versions of a function to print warning/error
 messages.
- 
+
 =cut
 
 */

Reply via email to