Fixed some POD formatting errors.

Corrected some typos. git-svn-id: https://svn.parrot.org/parrot/trunk@10340 d31e2699-5ff4-0310-a27c-f18f2fbe73fe
ashgti · Dec 4, 2005 · 90e09bd · 90e09bd
1 parent 43900ae
commit 90e09bd
Show file tree

Hide file tree

Showing 12 changed files with 54 additions and 54 deletions.
diff --git a/docs/BROKEN b/docs/BROKEN
@@ -153,7 +153,7 @@ source and argument information.
 
 Will Coleda is thinking about this.
 
-=item * Add rules engines for perl5-ish RE's in PGE.
+=item * Add rules engines for Perl 5-ish RE's in PGE.
 
 Will Coleda specifically wants
 http://www.tcl.tk/man/tcl8.5/TclCmd/re_syntax.htm, but having a P5-ish one to

diff --git a/docs/ROADMAP b/docs/ROADMAP
@@ -330,7 +330,7 @@ from floating point types, sprintf output of bignumbers. L<PDD14>
 
 =item *
 
-Implement the parrot equivalent of perl5's C<$0>, based on recent (January
+Implement the Parrot equivalent of Perl 5's C<$0>, based on recent (January
 2005) mailing list activity.
 
 =item *

diff --git a/docs/compiler_faq.pod b/docs/compiler_faq.pod
@@ -361,6 +361,8 @@ of one pad depth are numbered from 0..n-1 in the order of their declaration.
 
 =head2 How do I create a module?
 
+TODO
+
 =head2 How do I create a class?
 
 With the C<newclass> op:
@@ -500,8 +502,12 @@ key/value pairs:
 
 =head2 How do I add module/class methods?
 
+TODO
+
 =head2 How do I access module/class variables?
 
+TODO
+
 =head1 Exceptions
 
 =head2 How do I throw an exception in PIR?
@@ -557,15 +563,15 @@ More information is available inside the exception 'object' (TBD).
 
 =head1 Misc
 
-=head2 How can I access a programs environment.
+=head2 How can I access a program's environment?
 
 Create a new C<Env> PMC and access it like a hash.
 
     .local pmc e
     e = new .Env
     $P0 = e['USER']      # lt
 
-=head2 How can I access parrot's configuration.
+=head2 How can I access Parrot's configuration?
 
     .include "iglobals.pasm"
     .local pmc interp, cfg

diff --git a/docs/debug.pod b/docs/debug.pod
@@ -160,5 +160,3 @@ list of flags. Or have a look at the information provided by:
 or
 
   shell> parrot --help-debug
-
-=back
diff --git a/docs/extend.pod b/docs/extend.pod
@@ -8,7 +8,7 @@ extend.pod - Parrot extension system
 =head1 SYNOPSIS 
 
     #include "parrot/extend.h"
-    
+
     int main(int argc, char *argv[]) {
     }
 
@@ -26,15 +26,11 @@ extend.pod - Parrot extension system
 
 =head2 Data Structures
 
-=over 4
-
-=back
+TODO
 
 =head2 Constants
 
-=over 4
-
-=back
+TODO
 
 =head2 Functions
 

diff --git a/docs/faq.pod b/docs/faq.pod
@@ -10,9 +10,9 @@ docs/faq.pod - Parrot FAQ
 =head2 What is Parrot?
 
 Parrot is the new interpreter being designed from scratch to support the
-upcoming Perl6 language. It is being designed as a standalone virtual machine
-that can be used to execute bytecode compiled dynamic languages such as Perl6,
-but also Perl5. Ideally, Parrot can be used to support other dynamic,
+upcoming Perl 6 language. It is being designed as a standalone virtual machine
+that can be used to execute bytecode compiled dynamic languages such as Perl 6,
+but also Perl 5. Ideally, Parrot can be used to support other dynamic,
 bytecode-compiled languages such as Python, Ruby and Tcl.
 
 =head2 Why "Parrot"?
@@ -26,11 +26,11 @@ better.
 
 =head2 Is Parrot the same as Perl 6?
 
-No. Parrot is an implementation that is expected to be used to execute Perl6
-programs. The Perl6 language definition is currently being crafted by Larry
-Wall. While the true nature of Perl6 is still unknown, it will be substantially
+No. Parrot is an implementation that is expected to be used to execute Perl 6
+programs. The Perl 6 language definition is currently being crafted by Larry
+Wall. While the true nature of Perl 6 is still unknown, it will be substantially
 similar to Perl as we know it today, and will need a runtime system. For more
-information on the nascent Perl6 language definition, check out Larry's
+information on the nascent Perl 6 language definition, check out Larry's
 L<apocalypses|"LINKS">.
 
 =head2 Can I use Parrot today?
@@ -290,13 +290,13 @@ A variety of reasons were given for embarking on this project:
 
 =item *
 
-Perl5 is a stable, reliable, robust platform for developing software; it's not
-going away for a long time, even after Perl6 is released. (Proof: Perl4 is
+Perl 5 is a stable, reliable, robust platform for developing software; it's not
+going away for a long time, even after Perl 6 is released. (Proof: Perl 4 is
 still out there, no matter how much we all want it to go away.)
 
 =item *
 
-We have the ability to translate Perl5 into Perl6 if necessary. This preserves
+We have the ability to translate Perl 5 into Perl 6 if necessary. This preserves
 backward compatibility with a large body of existing Perl code, which is
 I<very> important.
 

diff --git a/docs/gettingstarted.pod b/docs/gettingstarted.pod
@@ -143,23 +143,23 @@ mailing list. There are a variety of interfaces to the list:
 
 =over 4
 
-=item * Mailing List Interface (subscribing, unsubscribing, etc)
+=item * Developer Mailing List Interface (subscribing, unsubscribing, etc)
 
 L<http://lists.perl.org/showlist.cgi?name=perl6-internals>
 
-=item * NNTP Interface
+=item * Perl 6 Internals NNTP Interface
 
 L<news://nntp.perl.org/perl.perl6.internals>
 
 L<http://nntp.x.perl.org/group/perl.perl6.internals>
 
-=item * Archives
+=item * Perl 6 Internals Archives
 
 L<http://groups.google.com/groups?hl=en&lr=&ie=UTF-8&oe=UTF-8&group=perl.perl6.internals>
 
 L<http://www.nntp.perl.org/group/perl.perl6.internals>
 
-=item * Searching
+=item * Searching the Perl 6 Internals Mailing List
 
 There are no directly searchable interfaces to the mailing lists. However,
 Google works quite well. After clicking the below links, just add your search
@@ -196,19 +196,19 @@ helpful to subscribe and keep up on changes that people are making.
 
 L<http://lists.perl.org/showlist.cgi?name=cvs-parrot>
 
-=item * NNTP Interface
+=item * Parrot Commits NNTP Interface
 
 L<news://nntp.perl.org/perl.cvs.parrot>
 
 L<http://nntp.x.perl.org/group/perl.cvs.parrot>
 
-=item * Archives
+=item * Commit List Archives
 
 L<http://groups.google.com/groups?hl=en&lr=&ie=UTF-8&oe=UTF-8&group=perl.cvs.parrot>
 
 L<http://www.nntp.perl.org/group/perl.cvs.parrot>
 
-=item * Searching
+=item * Searching the Parrot Commits List
 
 After clicking the below links, just add your search terms to the Google search
 box.
@@ -228,7 +228,7 @@ is an IRC channel which you may find useful if your problem is better solved
 with real-time discussion. To find this channel, visit the channel #parrot in 
 the following IRC servers (either one will do):
 
-L<irc://irc.rhizomatic.net>/ or L<irc://irc.pobox.com/>
+L<irc.rhizomatic.net> or L<irc.pobox.com>
 
 
 

diff --git a/docs/glossary.pod b/docs/glossary.pod
@@ -205,7 +205,7 @@ Acronym for Parrot Abstract Syntax Tree.
 =head2 Packfile
 
 Another name for a PBC file, due to the names used for data structures in one
-of the early implementations in Perl5.
+of the early implementations in Perl 5.
 
 =head2 PBC
 
@@ -220,7 +220,7 @@ See also L<"Packfile">.
 Acronym for Parrot Design Document. These documents describe the features that
 the Parrot interpreter should implement.
 
-See also L<"pdd00_pdd">.
+See also L<pdds/pdd00_pdd>.
 
 =head2 PIR
 
@@ -238,7 +238,7 @@ fundamental types, such as Perl's scalar values.
 
 =head2 POD
 
-POD is an acronym for Plain Old Documentation. This is for now the prefered
+POD is an acronym for Plain Old Documentation. This is for now the preferred
 form for all kinds of documentation in Parrot. See "perldoc perlpod" for
 details.
 
@@ -267,7 +267,7 @@ Core and the Prederef[erencing] Core.
 
 L<http://archive.develooper.com/perl6-internals@perl.org/msg07064.html>
 
-The week of 2003-02-09, Leopold Totsch combined Computed Goto and
+The week of 2003-02-09, Leopold Toetsch combined Computed Goto and
 Predereferencing to produce the CGP core.
 
 L<http://dev.perl.org/perl6/list-summaries/2003/p6summary.2003-02-09.html#Week_of_the_alternative_runloops>

diff --git a/docs/intro.pod b/docs/intro.pod
@@ -255,20 +255,20 @@ with a C<#> are comments.
       # State the number of squares to sum.
       .local int maxnum
       maxnum = 10
-      
+
       # Some named registers we'll use. Note how we can declare many
       # registers of the same type on one line.
       .local int i, total, temp
       total = 0
-      
+
       # Loop to do the sum.
       i = 1
   loop:
       temp = i * i
       total += temp
       inc i
       if i <= maxnum goto loop
-      
+
       # Output result.
       print "The sum of the first "
       print maxnum
@@ -318,41 +318,41 @@ compute factorial.
   .sub _fact
       # Get input parameter.
       .param int n
-      
+
       # return (n > 1 ? n * _fact(n - 1) : 1)
       .local int result
-      
+
       if n > 1 goto recurse
       result = 1
       goto return
-  
+
   recurse:
       $I0 = n - 1
       result = _fact($I0)
       result *= n
-      
+
   return:
       .return (result)
   .end
-  
-  
+
+
   .sub _main @MAIN
       .local int f, i
-      
+
       # We'll do factorial 0 to 1.
       i = 0
   loop:
       f = _fact(i)
-      
+
       print "Factorial of "
       print i
       print " is "
       print f
       print ".\n"
-      
+
       inc i
       if i <= 10 goto loop
-      
+
       # That's it.
       end
   .end

diff --git a/docs/parrot.pod b/docs/parrot.pod
@@ -123,7 +123,7 @@ Documentation for C<pdb>, the Parrot debugger.
 
 Parrot compiles and runs on a large number of platforms, including all common
 ones. The Parrot team is committed to supporting the following combinations as
-"core platforms": Linux (x86), CygWin, Win32, Tru64, OpenVMS (Alpha), Solaris
+"core platforms": Linux (x86), Cygwin, Win32, Tru64, OpenVMS (Alpha), Solaris
 (Sparc), FreeBSD (x86).
 
 =head2 Authors

diff --git a/docs/running.pod b/docs/running.pod
@@ -161,7 +161,7 @@ Run with the slow core and do print an execution profile.
 
 =item -P, --predereferenced-core
 
-Prederefernce opcode function arguments on the fly.
+Predereference opcode function arguments on the fly.
 
 =item -t, --trace
 

diff --git a/docs/tests.pod b/docs/tests.pod
@@ -105,24 +105,24 @@ C<language_output_is>.
 
 =over 4
 
-=item o
+=item *
 
 Probe the boundaries (including edge cases, errors thrown etc.) of whatever
 code they're testing.  These should include potentially out of band input
 unless we decide that compilers should check for this themselves.
 
-=item o
+=item *
 
 Are small and self contained, so that if the tested feature breaks we can
 identify where and why quickly.
 
-=item o
+=item *
 
 Are valid. Essentially, they should conform to the additional documentation
 that accompanies the feature (if any). [If there isn't any documentation, then
 feel free to add some and/or complain to the mailing list].
 
-=item o
+=item *
 
 Are a chunk of assembler and a chunk of expected output.