[svn:parrot] r36501 - trunk/languages/lua/doc
fperrad at svn.parrot.org
fperrad at svn.parrot.org
Mon Feb 9 18:32:18 UTC 2009
Author: fperrad
Date: Mon Feb 9 18:32:17 2009
New Revision: 36501
URL: https://trac.parrot.org/parrot/changeset/36501
Log:
[Lua] Abandoning daft Perl 5-style documentation headings.
Modified:
trunk/languages/lua/doc/lua51.bnf
trunk/languages/lua/doc/running.pod
trunk/languages/lua/doc/status.pod
Modified: trunk/languages/lua/doc/lua51.bnf
==============================================================================
--- trunk/languages/lua/doc/lua51.bnf Mon Feb 9 18:29:36 2009 (r36500)
+++ trunk/languages/lua/doc/lua51.bnf Mon Feb 9 18:32:17 2009 (r36501)
@@ -1,11 +1,9 @@
-# Copyright (C) 2005-2008, The Perl Foundation.
+# Copyright (C) 2005-2009, The Perl Foundation.
# $Id$
-=head1 NAME
+=head1 The Complete Syntax of Lua
-lua51.bnf - The Complete Syntax of Lua
-
-=head1 DESCRIPTION
+=head2 Description
The following grammar comes from "Lua 5.1 Reference Manual".
Modified: trunk/languages/lua/doc/running.pod
==============================================================================
--- trunk/languages/lua/doc/running.pod Mon Feb 9 18:29:36 2009 (r36500)
+++ trunk/languages/lua/doc/running.pod Mon Feb 9 18:32:17 2009 (r36501)
@@ -1,33 +1,30 @@
-# Copyright (C) 2005-2008, The Perl Foundation.
+# Copyright (C) 2005-2009, The Perl Foundation.
# $Id$
-=head1 TITLE
+=head1 Using Lua on Parrot
-Using Lua on Parrot
-
-=head1 In brief
+=head2 In brief
C<lua.pbc> is the Lua interpreter.
-=head1 Building
+=head2 Building
After building C<parrot> (see F<docs/gettingstarted.pod>):
cd languages/lua
make
-=head1 Running the whole test suite
+=head2 Running the whole test suite
make test
-=head1 Testing the test suite
+=head2 Testing the test suite
With an original C<Lua> in your path, it's possible to check the test suite.
- cd languages
- perl -I../lib -Ilua/t lua/t/harness --use-lua
+ perl t/harness --use-lua
-=head1 Running your own code
+=head2 Running your own code
../../parrot lua.pbc example.lua
@@ -35,15 +32,15 @@
../../parrot lua.pbc
-=head1 BUGS & LIMITATIONS
+=head2 Bugs & Limitations
See F<languages/lua/doc/status.pod>
-=head1 SEE ALSO
+=head2 See Also
F<languages/lua/doc/status.pod>
-=head1 AUTHOR
+=head2 Author
Francois Perrad.
Modified: trunk/languages/lua/doc/status.pod
==============================================================================
--- trunk/languages/lua/doc/status.pod Mon Feb 9 18:29:36 2009 (r36500)
+++ trunk/languages/lua/doc/status.pod Mon Feb 9 18:32:17 2009 (r36501)
@@ -1,11 +1,9 @@
-# Copyright (C) 2005-2008, The Perl Foundation.
+# Copyright (C) 2005-2009, The Perl Foundation.
# $Id$
-=head1 TITLE
+=head1 Status of Lua on Parrot
-Status of Lua on Parrot
-
-=head1 Introduction
+=head2 Introduction
Lua is an extension programming language designed to support general
procedural programming with data description facilities. It also offers
@@ -19,7 +17,7 @@
This implementation is aligned with Lua 5.1 specifications.
-=head1 PIR Compiler/Interpreter
+=head2 PIR Compiler/Interpreter
C<lua.pbc> is the interpreter/compiler, see F<languages/lua/src/lua51.pir>
& F<languages/lua/lua.pir>.
@@ -62,7 +60,7 @@
The code generation could be examined with F<languages/lua/luap.pir>.
-=head2 KNOWN PROBLEMS
+=head3 KNOWN PROBLEMS
in F<languages/lua/t/closure.t> :
@@ -85,7 +83,7 @@
C<y> variable is not different.
-=head1 Perl Compiler (deprecated)
+=head2 Perl Compiler (deprecated)
This compiler is written in Perl5 :
@@ -125,7 +123,7 @@
=back
-=head1 Lua Types
+=head2 Lua Types
There are eight basic types in Lua, each of them is implemented by a PMC.
@@ -164,15 +162,15 @@
F<languages/lua/src/pmc/lua.pmc> is a singleton PMC what holds some static methods.
-=head2 TODO
+=head3 TODO
Arguments passing in C<invoke> method of C<table>. Where are there ?
-=head2 IMPROVEMENT
+=head3 IMPROVEMENT
C<table> with a mixed array and hash (like Lua 5).
-=head1 Lua Standard Libraries
+=head2 Lua Standard Libraries
Lua 5.1 defines the following standard libraries:
@@ -202,11 +200,11 @@
F<languages/lua/src/lib/luaregex.pir> implements a regex compiler using PGE.
-=head2 TODO
+=head3 TODO
Complete some of these libraries.
-=head1 Extension Libraries
+=head2 Extension Libraries
These libraries are loaded dynamically with the Lua function C<require>.
@@ -242,16 +240,16 @@
=back
-=head1 Next Milestones
+=head2 Next Milestones
Debugging & stabilisation.
-=head2 FEEDBACK
+=head3 FEEDBACK
I try to summarize all my feedback, here :
L<http://www.nntp.perl.org/group/perl.perl6.internals/2007/10/msg40493.html>.
-=head1 Related Projects
+=head2 Related Projects
Klaas-Jan Stol works on 2 projects :
@@ -269,7 +267,7 @@
See L<http://kjs.home.fmf.nl/>.
-=head1 AUTHOR
+=head2 Author
Francois Perrad.
More information about the parrot-commits
mailing list