Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

update info on pir tests in main; don't generate packfile-perl.pod

git-svn-id: https://svn.parrot.org/parrot/trunk@5432 d31e2699-5ff4-0310-a27c-f18f2fbe73fe
  • Loading branch information...
commit 1acea2559f0dc89f16b65cea2a2170b04c5d1c5b 1 parent 58c0aa8
Leopold Toetsch authored
Showing with 17 additions and 8 deletions.
  1. +2 −5 config/gen/makefiles/docs.in
  2. +15 −3 docs/tests.pod
View
7 config/gen/makefiles/docs.in
@@ -6,7 +6,7 @@ MKDIR = $(PERL) -e ${PQ}-d or mkdir $$_,0777 or die foreach @ARGV${PQ}
POD = ${pod}
-all: doc-prep packfile-c.pod packfile-perl.pod $(POD)
+all: doc-prep packfile-c.pod $(POD)
doc-prep:
$(MKDIR) ops
@@ -14,9 +14,6 @@ doc-prep:
packfile-c.pod: ../src/packfile.c
perldoc -u ../src/packfile.c > packfile-c.pod
-packfile-perl.pod: ../lib/Parrot/PackFile.pm
- perldoc -u ../lib/Parrot/PackFile.pm > packfile-perl.pod
-
clean:
- $(RM_F) packfile-c.pod packfile-perl.pod $(POD)
+ $(RM_F) packfile-c.pod $(POD)
View
18 docs/tests.pod
@@ -9,7 +9,9 @@ written. The testing system is liable to change in the future, but
tests written following the guidelines below should be easy to port
into a new test suite.
-=head2 How to write a test
+=head1 How to write a test
+
+=head2 Assembler tests
First, find an appropriate file in F<t/op/*.t> (for basic ops),
F<t/pmc/*.t> (for anything to do with PMCs), and F<t/src/*.t> for C
@@ -37,7 +39,17 @@ by:
1
OUTPUT
-or, if it is a C test, some code like this:
+Tests in F<t/op/> or F<t/pmc/> are considered to be B<PASM> tests.
+Tests in F<imcc/t/> are assumed to be B<PIR> tests. You can put B<PIR>
+tests into F<t/op/> or F<t/pmc/> by inserting the special comment B<##PIR##>
+in the test code:
+
+ output_is(<<'CODE', <<'OUTPUT', "name for test");
+ ##PIR##
+ $P0 = new Integer
+ ...
+
+=head2 C source tests
c_output_is(<<'CODE', <<'OUTPUT', "name for test");
#include <stdio.h>
@@ -77,7 +89,7 @@ Note, it's always a good idea to output "done" to confirm that the compiled
code executed completely. When mixing C<printf> and C<PIO_printf> always
append a C<fflush(stdout);> after the former.
-=head2 Ideal tests:
+=head1 Ideal tests:
=over 4
Please sign in to comment.
Something went wrong with that request. Please try again.