Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 144 lines (84 sloc) 3.502 kB
6da188c update platform information
Gerd Pokorra authored
1 # Copyright (C) 2001-2010, Parrot Foundation.
9b4e5d0 Fixups to make parrotcode.org's autogenerated pages happier
Dan Sugalski authored
2
9d8cce4 a bit more tidying up
Michael Scott authored
3 =head1 NAME
4
5 docs/parrot.pod - Parrot
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
6
2e13b23 @allisonrandal [cage] Caught a few stale links and descriptions in introductory doc.
allisonrandal authored
7 =head1 The Parrot Virtual Machine
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
8
809fcc9 @bschmalhofer [doc] Minor change in wording.
bschmalhofer authored
9 Parrot is a language-agnostic common bytecode format and an interpreter for
2e13b23 @allisonrandal [cage] Caught a few stale links and descriptions in introductory doc.
allisonrandal authored
10 dynamic languages.
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
11
12 =head2 Documentation
13
05a7e7b @bschmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
14 The Parrot documentation is spread across a wide range of files. Good starting
15 points are:
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
16
c949c88 Better discussion of what documentation is available and where it is
Simon Glover authored
17 =over 4
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
18
19 =item F<intro.pod>
20
05a7e7b @bschmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
21 An introductory article on what Parrot is and how to do some interesting things
22 with it.
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
23
24 =item F<overview.pod>
25
26 An overview of the Parrot architecture and design.
27
7b223c1 This patch add docs/running.pod, which lists the various executables
Dan Sugalski authored
28 =item F<running.pod>
29
05a7e7b @bschmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
30 Brief descriptions of the different executables and how to run them.
7b223c1 This patch add docs/running.pod, which lists the various executables
Dan Sugalski authored
31
1248b76 @brentdax Move the FAQ into POD and add a new question/answer pair.
brentdax authored
32 =item F<faq.pod>
33
34 The Parrot FAQ.
35
c949c88 Better discussion of what documentation is available and where it is
Simon Glover authored
36 =item F<glossary.pod>
37
38 A guide to some of the jargon that crops up repeatedly in Parrot development
39 (and in the documentation...)
40
41 =back
42
05a7e7b @bschmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
43 More detailed information on the design and implementation of Parrot can be
44 found in:
c949c88 Better discussion of what documentation is available and where it is
Simon Glover authored
45
46 =over 4
47
48 =item F<pdds/>
49
50 This subdirectory contains all of the current Parrot Design Documents (PDDs).
05a7e7b @bschmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
51 These are intended to be detailed guides to the design of the various Parrot
52 subsystems; for instance, F<pdd03_calling_conventions.pod> specifies Parrot's
53 inter-routine calling conventions.
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
54
c949c88 Better discussion of what documentation is available and where it is
Simon Glover authored
55 =item F<ops/>
56
05a7e7b @bschmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
57 This subdirectory contains documentation files that are created from the
58 corresponding opcode files at build time. These files describe what each opcode
ea0630c @jhoblitt reformat all Pod files under docs with podtidy (modified to also remo…
jhoblitt authored
59 does and specify what arguments they take.
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
60
c949c88 Better discussion of what documentation is available and where it is
Simon Glover authored
61 =item F<pmc/>
62
05a7e7b @bschmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
63 This subdirectory contains documentation on several of the PMC types available
64 to Parrot. Currently only a few of the available PMCs have been documented.
65 (Patches welcome!)
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
66
c949c88 Better discussion of what documentation is available and where it is
Simon Glover authored
67 =item F<dev/>
68
69 This subdirectory contains a number of files discussing various implementation
05a7e7b @bschmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
70 decisions made during the course of the development of Parrot. The intent is to
71 keep discussion of implementation-specific issues separate from the basic
72 design issues discussed in the PDDs.
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
73
74 =item F<vtables.pod>
75
05a7e7b @bschmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
76 A brief introduction to the vtable at the heart of all PMCs, and how to
77 implement your own PMC type.
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
78
9ce7470 @brentdax Document this newfangled embedding subsystem.
brentdax authored
79 =item F<embed.pod>
80
81 Describes the embedding subsystem in excruciating detail.
82
c949c88 Better discussion of what documentation is available and where it is
Simon Glover authored
83 =item F<memory_internals.pod>
84
85 An introduction to the Parrot GC subsystem
86
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
87 =item F<parrotbyte.pod>
88
89 The Parrot bytecode format.
90
91 =item F<packfile-perl.pod>, F<packfile-c.pod>
92
ea0630c @jhoblitt reformat all Pod files under docs with podtidy (modified to also remo…
jhoblitt authored
93 The APIs for accessing packed bytecode files (packfiles) from Perl and C.
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
94
95 =item F<strings.pod>
96
97 A description of the string implementation.
98
99 =item F<tests.pod>
100
101 Hints on writing tests for the Parrot interpreter.
102
e6651cb Update in light of the ops split-up
Simon Glover authored
103 =item F<debug.pod>
104
105 A beginner's guide to debugging the Parrot executable.
106
107 =item F<debugger.pod>
108
213a519 @NotFound Rename pdb to parrot_debugger after Reini Urban suggestions and later…
NotFound authored
109 Documentation for C<parrot_debugger>, the Parrot debugger.
e6651cb Update in light of the ops split-up
Simon Glover authored
110
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
111 =back
112
113 =head2 Supported Platforms
114
05a7e7b @bschmalhofer This patch is huge because of all the whitespace reformatting. This was
bschmalhofer authored
115 Parrot compiles and runs on a large number of platforms, including all common
116 ones. The Parrot team is committed to supporting the following combinations as
6da188c update platform information
Gerd Pokorra authored
117 "core platforms": Linux (x86), Win32 (x86), OS X (x86 and PPC), Cygwin,
118 FreeBSD (x86), NetBSD, OpenBSD, Solaris.
119 Here x86 includes the x86_64 architecture. x86 describes that Parrot is
120 supported to run on a 32-bit and 64-bit (AMD64 and Intel 64) CPU.
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
121
122 =head2 Authors
123
124 Parrot is developed and maintained by the members of the
66ddda2 @Infinoid [docs] Fix up old references to submitting/subscribing/archives for t…
Infinoid authored
125 C<parrot-dev@lists.parrot.org> mailing list. The list is archived at:
126 L<http://groups.google.com/group/parrot-dev/>
3262909 @allisonrandal [cage] Updating author information in introductory doc.
allisonrandal authored
127 Many people have contributed their time and expertise
dc9ff4b Update release manager list. Include a pointer to the CREDITS file
Simon Glover authored
128 to the Parrot project; see the F<CREDITS> file for details.
ca0480d Doc patch as suggested by Will Coleda (wcoleda@nucap.rr.com)
Josh Wilmes authored
129
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
130 =head2 Web pages
131
f56dc07 Text fixups
Dan Sugalski authored
132 See:
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
133
f56dc07 Text fixups
Dan Sugalski authored
134 =over 4
135
1a290c7 @bschmalhofer [docs] s/parrotcode.org/parrot.org/
bschmalhofer authored
136 =item * L<http://www.parrot.org/>
7483031 @coke [docs]
coke authored
137
92b31ca @leto [docs] Update parrot.pod with github link
leto authored
138 =item * L<http://github.com/parrot/parrot>
f56dc07 Text fixups
Dan Sugalski authored
139
140 =back
495455c @simoncozens Getting the documentation up to scratch.
simoncozens authored
141
142 for more information.
1772034 @jhoblitt reformat all Pod files under docs with podtidy except for docs/pdds
jhoblitt authored
143
Something went wrong with that request. Please try again.