cvsuser     05/02/20 11:25:37

  Modified:    .        README
               imcc/docs calling_conventions.pod imcc.pod operation.pod
                        parsing.pod running.pod syntax.pod
               lib/Parrot/Docs File.pm
               lib/Parrot/Docs/Section Info.pm
  Log:
  These are some documentation tidbits:
  - Add CVS Id-macros
  - Add Copyright notice
  - Do not mention KNOWN_ISSUES any more.
  - Added a couple of URLs in README
  
  Revision  Changes    Path
  1.47      +5 -5      parrot/README
  
  Index: README
  ===================================================================
  RCS file: /cvs/public/parrot/README,v
  retrieving revision 1.46
  retrieving revision 1.47
  diff -u -r1.46 -r1.47
  --- README    13 Jan 2005 06:31:54 -0000      1.46
  +++ README    20 Feb 2005 19:25:34 -0000      1.47
  @@ -37,9 +37,6 @@
   a temporary solution. It will be happy with most any answers
   you decide to feed it. Garbage In, Garbage Out.
   
  -You may want to peruse the list of KNOWN_ISSUES to see
  -what other things may be unexpected.
  -
   INSTRUCTIONS
   ------------
   
  @@ -127,7 +124,8 @@
   available as ChangeLog.
   
   CVS history can be browsed online at
  -http://cvs.perl.org/viewcvs/cvs-public/parrot/
  +http://cvs.perl.org/viewcvs/cvs-public/parrot/ at
  
+http://bugs6.perl.org/cgi-bin/cvsmonitor/cvsmonitor.pl?cmd=viewBrowseModule&module=perlpublic.parrot
 .
   
   MAILING LISTS
   -------------
  @@ -147,7 +145,9 @@
       http://www.parrotcode.org/
       http://dev.perl.org/perl6/
       http://cvs.perl.org/
  +    http://bugs6.perl.org/
  +    http://pugscode.org/
   
   
   Have fun,
  -The Parrot Team.
  +   The Parrot Team.
  
  
  
  1.24      +3 -0      parrot/imcc/docs/calling_conventions.pod
  
  Index: calling_conventions.pod
  ===================================================================
  RCS file: /cvs/public/parrot/imcc/docs/calling_conventions.pod,v
  retrieving revision 1.23
  retrieving revision 1.24
  diff -u -r1.23 -r1.24
  --- calling_conventions.pod   4 Nov 2004 08:21:03 -0000       1.23
  +++ calling_conventions.pod   20 Feb 2005 19:25:35 -0000      1.24
  @@ -1,3 +1,6 @@
  +# Copyright: 2001-2005 The Perl Foundation.  All Rights Reserved.
  +# $Id: calling_conventions.pod,v 1.24 2005/02/20 19:25:35 bernhard Exp $
  +
   =head1 NAME
   
   PIR - calling conventions
  
  
  
  1.8       +5 -2      parrot/imcc/docs/imcc.pod
  
  Index: imcc.pod
  ===================================================================
  RCS file: /cvs/public/parrot/imcc/docs/imcc.pod,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- imcc.pod  11 Jan 2005 03:34:22 -0000      1.7
  +++ imcc.pod  20 Feb 2005 19:25:35 -0000      1.8
  @@ -1,3 +1,6 @@
  +# Copyright: 2001-2005 The Perl Foundation.  All Rights Reserved.
  +# $Id: imcc.pod,v 1.8 2005/02/20 19:25:35 bernhard Exp $
  +
   =head1 NAME
   
   IMCC - documentation
  @@ -12,7 +15,7 @@
   
   =head1 OVERVIEW
   
  -IMCC is the Intermediate Code Compiler for Parrot.  It's integrated into the
  +IMCC is the B<I>nterB<m>ediate B<C>ode B<C>ompiler for Parrot.  It's 
integrated into the
   C<parrot> executable.
   
   IMCC compiles a language called Parrot Intermediate Representation (PIR).  
PIR
  @@ -29,7 +32,7 @@
   =head2 calling_conventions.pod
   
   Describes the standard way of passing arguments and receiving results from
  -subroutines.
  +subroutines. See also pdd/003_calling_conventions.pod.
   
   =head2 imcfaq.pod
   
  
  
  
  1.9       +7 -5      parrot/imcc/docs/operation.pod
  
  Index: operation.pod
  ===================================================================
  RCS file: /cvs/public/parrot/imcc/docs/operation.pod,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- operation.pod     1 Jan 2005 18:07:42 -0000       1.8
  +++ operation.pod     20 Feb 2005 19:25:35 -0000      1.9
  @@ -1,3 +1,6 @@
  +# Copyright: 2001-2005 The Perl Foundation.  All Rights Reserved.
  +# $Id: operation.pod,v 1.9 2005/02/20 19:25:35 bernhard Exp $
  +
   =head1 NAME
   
   IMCC - operation
  @@ -14,7 +17,7 @@
   
   =head1 OVERVIEW
   
  -This document describes the principles of imcc operation.
  +This document describes the principles of IMCC operation.
   
   =head1 DESCRIPTION
   
  @@ -42,7 +45,7 @@
   
   Register allocation is done per I<compilation unit>.
   
  -Imcc I<identifiers> and I<temporary variables> e.g. $I0 are assigned a
  +IMCC I<identifiers> and I<temporary variables> e.g. $I0 are assigned a
   physical parrot register depending on the life range of these
   variables. If the life range of one variable doesn't overlap the range
   of another variable, they might get the same parrot register. For 
  @@ -108,7 +111,7 @@
   
   Consider these two code snippets (block numbers are attached):
   
  -  .sub _main
  +  .sub main @MAIN
    0      $I0 = 0              # initialized
    0      if $I0 goto l1
    1      $I1 = 1              # init in block 1
  @@ -124,7 +127,7 @@
   
   and:
   
  -  .sub _main
  +  .sub main @MAIN 
    0      $I0 = 0              # initialized
    0      if $I0 goto l1       # branch to bb 1 or 2
    1      $I1 = 1              # init only in block 1
  @@ -273,4 +276,3 @@
   
   Leopold Toetsch <[EMAIL PROTECTED]>
   
  -
  
  
  
  1.13      +7 -4      parrot/imcc/docs/parsing.pod
  
  Index: parsing.pod
  ===================================================================
  RCS file: /cvs/public/parrot/imcc/docs/parsing.pod,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- parsing.pod       11 Jan 2005 03:55:19 -0000      1.12
  +++ parsing.pod       20 Feb 2005 19:25:35 -0000      1.13
  @@ -1,3 +1,6 @@
  +# Copyright: 2001-2005 The Perl Foundation.  All Rights Reserved.
  +# $Id: parsing.pod,v 1.13 2005/02/20 19:25:35 bernhard Exp $
  +
   =head1 NAME
   
   IMCC - parsing
  @@ -18,11 +21,11 @@
   
   =head1 OVERVIEW
   
  -This document describes the basic parsing functionality of imcc.
  +This document describes the basic parsing functionality of IMCC.
   
   =head1 DESCRIPTION
   
  -Imcc parses and generates code in terms of I<compilation units>. These
  +IMCC parses and generates code in terms of I<compilation units>. These
   are self-contained blocks of code very similar to subroutines.
   
   Code for a compilation unit is created as soon (or not earlier) as the
  @@ -56,7 +59,7 @@
   
   This code:
   
  -     .sub _name
  +     .sub name
                statements
                ...
        .end
  @@ -67,7 +70,7 @@
   
   =head2 Subroutines: .pcc_sub ... .end
   
  -     .pcc_sub _name
  +     .sub name
                statements
                ...
        .end
  
  
  
  1.17      +3 -0      parrot/imcc/docs/running.pod
  
  Index: running.pod
  ===================================================================
  RCS file: /cvs/public/parrot/imcc/docs/running.pod,v
  retrieving revision 1.16
  retrieving revision 1.17
  diff -u -r1.16 -r1.17
  --- running.pod       27 Feb 2004 20:25:54 -0000      1.16
  +++ running.pod       20 Feb 2005 19:25:35 -0000      1.17
  @@ -1,3 +1,6 @@
  +# Copyright: 2001-2005 The Perl Foundation.  All Rights Reserved.
  +# $Id: running.pod,v 1.17 2005/02/20 19:25:35 bernhard Exp $
  +
   =head1 NAME
   
   Parrot - running
  
  
  
  1.11      +7 -6      parrot/imcc/docs/syntax.pod
  
  Index: syntax.pod
  ===================================================================
  RCS file: /cvs/public/parrot/imcc/docs/syntax.pod,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- syntax.pod        13 Oct 2004 07:05:16 -0000      1.10
  +++ syntax.pod        20 Feb 2005 19:25:35 -0000      1.11
  @@ -1,3 +1,6 @@
  +# Copyright: 2001-2005 The Perl Foundation.  All Rights Reserved.
  +# $Id: syntax.pod,v 1.11 2005/02/20 19:25:35 bernhard Exp $
  +
   =head1 NAME
   
   IMCC - syntax
  @@ -12,7 +15,7 @@
   
   =head1 OVERVIEW
   
  -This document describes the imcc syntax.
  +This document describes the IMCC syntax.
   
   =head1 DESCRIPTION
   
  @@ -56,7 +59,7 @@
   
   =item <type>
   
  -B<int>, B<float>, B<string> or a valid parrot PMC type like
  +B<int>, B<float>, B<string>, B<pmc> or a valid parrot PMC type like
   B<PerlArray>.
   
   =item <reg>
  @@ -96,11 +99,11 @@
   
   =over 4
   
  -=item .sub <_identifier>
  +=item .sub <identifier>
   
   =item .end
   
  -Define a I<compilation unit> with the label B<_identifier:>.
  +Define a I<compilation unit> with the label B<identifier:>.
   
   =item .emit
   
  @@ -257,5 +260,3 @@
   =head1 AUTHOR
   
   Leopold Toetsch <[EMAIL PROTECTED]>
  -
  -
  
  
  
  1.17      +2 -3      parrot/lib/Parrot/Docs/File.pm
  
  Index: File.pm
  ===================================================================
  RCS file: /cvs/public/parrot/lib/Parrot/Docs/File.pm,v
  retrieving revision 1.16
  retrieving revision 1.17
  diff -u -r1.16 -r1.17
  --- File.pm   27 Mar 2004 22:22:45 -0000      1.16
  +++ File.pm   20 Feb 2005 19:25:36 -0000      1.17
  @@ -1,5 +1,5 @@
   # Copyright: 2004 The Perl Foundation.  All Rights Reserved.
  -# $Id: File.pm,v 1.16 2004/03/27 22:22:45 mikescott Exp $
  +# $Id: File.pm,v 1.17 2005/02/20 19:25:36 bernhard Exp $
   
   =head1 NAME
   
  @@ -112,7 +112,6 @@
        'DEVELOPING' => 'Project info',
        'harness' => 'Perl test harness',
        'INSTALL' => 'Installation documentation',
  -     'KNOWN_ISSUES' => 'Project info',
        'LICENSE' => 'Licence file',
        'MAINTAINER' => 'Maintainer info',
        'Makefile' => 'Makefile',
  @@ -446,4 +445,4 @@
   
   =cut
   
  -1;
  \ No newline at end of file
  +1;
  
  
  
  1.7       +2 -3      parrot/lib/Parrot/Docs/Section/Info.pm
  
  Index: Info.pm
  ===================================================================
  RCS file: /cvs/public/parrot/lib/Parrot/Docs/Section/Info.pm,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- Info.pm   27 Mar 2004 22:22:49 -0000      1.6
  +++ Info.pm   20 Feb 2005 19:25:37 -0000      1.7
  @@ -1,5 +1,5 @@
   # Copyright: 2004 The Perl Foundation.  All Rights Reserved.
  -# $Id: Info.pm,v 1.6 2004/03/27 22:22:49 mikescott Exp $
  +# $Id: Info.pm,v 1.7 2005/02/20 19:25:37 bernhard Exp $
   
   =head1 NAME
   
  @@ -43,7 +43,6 @@
                $self->new_group('Documentation', '',
                        $self->new_item('General information about licences, 
prerequisites, and building instructions.', 'README'),
                        $self->new_item('This file lists what\'s new in each 
version.', 'NEWS'),
  -                     $self->new_item('This is a list of thing that are known 
to be broken or at least provisionally implemented.', 'KNOWN_ISSUES'),
                        $self->new_item('A list of things that need doing in 
Parrot.', 'TODO'),
                        $self->new_item('This is a description of the steps 
someone should follow when they have to prepare a new version for release.', 
'RELEASE_INSTRUCTIONS'),
                ),
  @@ -75,4 +74,4 @@
   
   =cut
   
  -1;
  \ No newline at end of file
  +1;
  
  
  

Reply via email to