# New Ticket Created by Andy Wardley
# Please include the string: [perl #63394]
# in the subject line of all future correspondence about this issue.
# <URL: http://rt.perl.org/rt3/Ticket/Display.html?id=63394 >
This patch:
1) Updates the docs/pct/gettingstarted.pod documentation to reflect that
fact that the newly created language will have a Configure.pl file of
its own. The user must run this script instead of the top level
Configure.pl. It also adds the Configure.pl, pmc/pmc.foo, ops/foo.ops,
STATUS and MAINTAINER files to the list of files created in the
languages/foo directory.
2) Adds my name to the CREDITS file.
Output from diffstat:
CREDITS | 5 +++++
docs/pct/gettingstarted.pod | 35 ++++++++++++++++++++---------------
2 files changed, 25 insertions(+), 15 deletions(-)
Regards
A
Index: docs/pct/gettingstarted.pod
===================================================================
--- docs/pct/gettingstarted.pod (revision 36930)
+++ docs/pct/gettingstarted.pod (working copy)
@@ -107,16 +107,12 @@
$ perl tools/dev/mk_language_shell Foo languages/foo
-This will create a complete language that compiles out of the box, except for
-the fact that there's no Makefile yet. In order to resolve that, you should
-(re)run the Configure.pl script:
+This will create a complete language that compiles out of the box. You first
+need to run the C<Configure.PL> Perl script to generate the C<Makefile>. Then
+you can run C<make> and C<make test>.
+ $ cd languages/foo
$ perl Configure.pl
-
-This will regenerate all makefiles, including the one for your language. Now,
-in order to compile your language, type:
-
- $ cd languages/foo
$ make
$ make test
@@ -126,6 +122,7 @@
The generated directories and files have the following structure:
foo/
+ /Configure.pl # configuration script
/config/makefiles/root.in # input for the Makefile generator
# as long as you don't add source files,
# there's no need to update this file.
@@ -136,15 +133,23 @@
/grammar-oper.pg # file containing a default operator table.
/builtins/
- /say.pir # a file containing a built-in function
- # add more "standard library" routines here
+ /say.pir # a file containing a built-in function
+
+ /pmc/
+ /foo.pmc # file defining vtable functions
+
+ /ops/
+ /foo.ops # file defining opcodes
+ # TODO: add more "standard library" routines here
/t/
- /00-sanity.t # a test file
- /harness # file to set up the test framework
- # more tests can be added here
+ /00-sanity.t # a test file
+ /harness # file to set up the test framework
+ # more tests can be added here
- /foo.pir # file containing the main routine
- /README # an almost empty readme file
+ /foo.pir # file containing the main routine
+ /README # an almost empty readme file
+ /STATUS # an almost empty status file
+ /MAINTAINER # a file for you to add your details to
When you want to run a script through your language's compiler, (assuming
Index: CREDITS
===================================================================
--- CREDITS (revision 36930)
+++ CREDITS (working copy)
@@ -106,6 +106,11 @@
E: a...@petdance.com
U: petdance
+N: Andy Wardley
+E: a...@wardley.org
+W: http://wardley.org/
+D: Minor documentation fixes
+
N: Angel Faus
D: CFG and live analysis.
