cvs commit: parrot/imcc/docs imcc.pod

[chromatic]

cvsuser     04/01/31 14:56:13

  Modified:    imcc/docs imcc.pod
  Log:
  Update IMCC docs per Bernhard Schmalhofer's patch in #24553.
  
  Revision  Changes    Path
  1.6       +30 -11    parrot/imcc/docs/imcc.pod
  
  Index: imcc.pod
  ===================================================================
  RCS file: /cvs/public/parrot/imcc/docs/imcc.pod,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -w -r1.5 -r1.6
  --- imcc.pod  23 Oct 2003 17:02:54 -0000      1.5
  +++ imcc.pod  31 Jan 2004 22:56:13 -0000      1.6
  @@ -12,30 +12,50 @@
   
   =head1 OVERVIEW
   
  -IMCC is the Intermediate Code Compiler for Parrot.  The language it
  -compiles is termed Parrot Intermediate Language (PIR).
  +IMCC is the Intermediate Code Compiler for Parrot.  It's integrated into the
  +C<parrot> executable.
   
  -This document describes available IMCC documentation.
  +IMCC compiles a language called Parrot Intermediate Representation (PIR).  PIR
  +is the primary target of language implementations. PIR code files usually have
  +the extension C<.imc>.
  +
  +This document describes available IMCC documentation, located in
  +parrot/imcc/docs unless otherwise described. 
  +
  +See also the documentation in parrot/docs.
   
   =head1 DESCRIPTION
   
  -=head2 running.pod
  +=head2 calling_conventions.pod
  +
  +Describes the standard way of passing arguments and receiving results from
  +subroutines.
   
  -IMCC's command line options.
  +=head2 imcfaq.pod
  +
  +A must read for potential language implementors.
  +
  +=head2 macros.pod
  +
  +The macro layer of parrot.
  +
  +=head2 operation.pod
  +
  +Describes how IMCC operates internally. 
   
   =head2 parsing.pod
   
   Basic parsing functionality.
   
  -=head2 syntax.pod
  +=head2 running.pod
   
  -The syntax of B<.imc> files.
  +parrot's command line options.
   
  -=head2 operation.pod
  +=head2 syntax.pod
   
  -IMCC operation basics.
  +The syntax of C<.imc> files.
   
  -=head2 README
  +=head2 parrot/imcc/README
   
   Summary of IMCC features and syntax.
   
  @@ -46,4 +66,3 @@
   =head1 AUTHOR
   
   Leopold Toetsch <[EMAIL PROTECTED]>
  -