docs/gettingstarted.pod - Parrot Developer FAQ
This document is the Developer FAQ for Parrot.
I'm interested in helping out. What should I do?
You're already on the right track. This FAQ should help you find everything you need to become an active member of the Parrot community. Just look through the questions below and read the ones that apply to you.
More current information is also available at https://trac.parrot.org/parrot/wiki/NewParrotDeveloperGuide.
Where can I get Parrot?
There is a web interface to the git repository, in case you just want to browse the source.
The easiest solution is to grab the latest monthly development release. You can find it here:
An even better option is to use git, which gets you the very latest copy of the Parrot distribution. The procedure for this is:
git clone http://github.com/parrot/parrot
The above instructions are also on the Parrot website:
Now that I've got Parrot, what do I do?
Now that you've downloaded Parrot, you probably want to try it out. All you need is Perl 5.8.0 or later, a C compiler (any ANSI C compliant compiler should do - if you find one that doesn't work, please report it to us), and some reasonable form of
make. To do this, follow these three easy steps.
cdto your parrot directory and run
perl Configure.plto create the makefile for your platform.
maketo compile everything and build parrot.
make testto run the test suite and verify that everything works on your system.
Where's the Parrot documentation?
Well, Parrot documentation is a great place to contribute, should you be looking for something to do. Figure out which parts were confusing, and either help us fix them, or let us know where we should fix them. Luckily, all of the current Parrot documentation is included along with the Parrot distribution, in the /docs/ directory.
We also have auto-generated HTML documentation, which is available through executing the following command in the Parrot distribution's root directory:
% make html
To view the HTML documentation, start with the docs/html/index.html page.
We have several categories of documentation, each with a different purpose. It will, probably, prove useful to you if you are aware of them before you go digging around in them. We strongly suggest you review /docs/pdds/pdd07_codingstd.pod for guidance on how best to layout the documentation. But for now, here's the executive summary:
Parrot Design Documents (PDDs) document the basic design of the Parrot interpreter, with each PDD focusing on a particular topic, such as the design of the garbage collector (PDD 09) or the object system (PDD 15). They can be found in the /docs/pdds directory.
NB: Some important areas are still missing PDDs; we're working to rectify that.
These are files which correspond to a specific source file, and can be found in /docs/dev/. A developer file contains documentation on all the implementation decisions associated with the source file. (Note that this is in contrast to PDDs, which describe design decisions). This is the place for mini-essays on how to avoid overflows in unsigned arithmetic, or on the pros and cons of differing hash algorithms, and why the current one was chosen, and how it works.
If you are coming to a particular source file for the first time, you should be able to read the developer file and gain an immediate overview of what the source file is for, the algorithms it implements, etc.
NB: We need more developer files too. Patches welcome!
Source file documentation
Each source file includes comments embedded in the document. Usually this means function-level documentation that describes the purpose and intent of a function, along with any other important information. For larger functions, it will include additional documentation that explains the meaning of code, as opposed to a verbatim translation of code.
Where can I find the main developer mailing list?
Most of the Parrot-related development discussion occurs on the parrot-dev (previously known as parrot-porters and perl6-internals) mailing list. There are a variety of interfaces to the list:
Developer Mailing List Interface (subscribing, unsubscribing, etc)
Parrot NNTP Interface
Parrot Archives, RSS
http://groups.google.com/group/parrot-dev provides archives, search, and RSS feeds.
In addition, there is a mailing list which logs all commits to the Parrot Git repository. If you're interested in Parrot development, you might find it very helpful to subscribe and keep up on changes that people are making.
Mailing List Interface (subscribing, unsubscribing, etc)
Commit List Archives, RSS
What other ways can I get in contact with the Parrot developers?
The mailing list is the main resource for Parrot development. However, there is an IRC channel which you may find useful if your problem is better solved with real-time discussion. Visit the channel #parrot on the IRC server irc.parrot.org. Alternative IRC servers are irc.rhizomatic.net and irc.pobox.com.
I've developed a patch. What should I do with it?
See docs/submissions.pod for details.
I've found a bug, what now?
See docs/submissions.pod for details.
What other useful resources are there for developers?
A number of other useful resources that can be found via on the Parrot wiki, located at https://github.com/parrot/parrot/wiki