-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
453 changed files
with
116,266 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# ex: set ro: | ||
# DO NOT EDIT THIS FILE | ||
# Generated by Parrot::Configure::Compiler from config/gen/makefiles/docs.in | ||
|
||
# Copyright (C) 2001-2010, Parrot Foundation. | ||
|
||
# Setup of some commands | ||
PERL = /usr/bin/perl | ||
CHMOD = $(PERL) -MExtUtils::Command -e chmod | ||
MKPATH = $(PERL) -MExtUtils::Command -e mkpath | ||
TOUCH = $(PERL) -MExtUtils::Command -e touch | ||
RM_F = $(PERL) -MExtUtils::Command -e rm_f | ||
RM_RF = $(PERL) -MExtUtils::Command -e rm_rf | ||
PERLDOC_BIN = /usr/bin/perldoc | ||
VERSION = 4.4.0-devel | ||
|
||
# | ||
# Targets | ||
# | ||
# This is a listing of all targets, that are meant to be called by users | ||
# Most of them are proxied in the root makefile parrot/Makefile | ||
help : | ||
@echo "" | ||
@echo "Following targets are available:" | ||
@echo "" | ||
@echo "help Generate this usage statement." | ||
@echo " This is the default target." | ||
@echo "" | ||
@echo "html Generate html documentation" | ||
@echo "html-clean Remove html documentation" | ||
@echo "" | ||
@echo "htmlhelp: windows only, generate a .chm file." | ||
@echo "htmlhelp-clean: Remove generated .chm" | ||
@echo "" | ||
@echo "pdf: Generate a PDF from the html docs" | ||
@echo "pdf-clean: Remove generated pdf" | ||
@echo "" | ||
@echo " clean: Invoke all clean targets" | ||
@echo "" | ||
|
||
clean: htmlhelp-clean html-clean | ||
|
||
html: | ||
$(PERL) -I../lib ../tools/docs/mk_html_docs.pl --version=$(VERSION) | ||
html-clean: | ||
$(RM_RF) html | ||
|
||
# If you are missing the command 'pdflatex' then you have first to install a | ||
# LaTeX distribution with it. For Windows and UNIX downloads are for example | ||
# available from: http://miktex.org, http://tug.org/texlive or | ||
# http://www.ctan.org | ||
pdf: ../tools/docs/filename_and_chapter.pl | ||
$(MKPATH) build/modified_pod | ||
$(PERL) ../tools/docs/filename_and_chapter.pl | ||
cd build && pdflatex parrot-book.tex && pdflatex parrot-book.tex | ||
|
||
#pdf-release: build/parrot-book.pdf | ||
# cp build/parrot-book.pdf build/parrot-book-$$(date +"%Y.%m").pdf | ||
|
||
pdf-clean: | ||
$(RM_RF) build | ||
|
||
htmlhelp: html | ||
|
||
htmlhelp-clean: | ||
|
||
# Local variables: | ||
# mode: makefile | ||
# End: | ||
# vim: ft=make: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,230 @@ | ||
# Copyright (C) 2001-2012, Parrot Foundation. | ||
|
||
=pod | ||
|
||
=head1 NAME | ||
|
||
docs/README.pod - Readme file for the 'docs/' directory. | ||
|
||
=head1 DESCRIPTION | ||
|
||
This README sets out the documents and directories in the 'docs/' top-level | ||
directory.[1] | ||
|
||
=head2 Documentation | ||
|
||
=over 4 | ||
|
||
=item F<binaries/> | ||
|
||
The pod files for Parrot's installable executables. | ||
|
||
=item F<book/> | ||
|
||
The pod files for the "PCT Book," the "PIR Book," and a draft of the "Parrot | ||
Developer's Guide: PIR Book". | ||
|
||
=item F<compiler_faq.pod> | ||
|
||
A Parrot FAQ for compiler writers in PIR.[2] | ||
|
||
=item F<configuration.pod> | ||
|
||
A document on Parrot's Configuration System. | ||
|
||
=item F<debugger.pod> | ||
|
||
Documentation for C<parrot_debugger>, the Parrot debugger. | ||
|
||
=item F<debug.pod> | ||
|
||
A beginner's guide to debugging the Parrot executable. | ||
|
||
=item F<deprecations/> | ||
|
||
Documentation on Parrot's deprecation policy and documents on various Parrot | ||
deprecations. | ||
|
||
=item F<dev/> | ||
|
||
This subdirectory contains a number of files discussing various implementation | ||
decisions made during the course of the development of Parrot. The intent is | ||
to keep discussion of implementation-specific issues separate from the basic | ||
design issues discussed in the PDDs. | ||
|
||
=item F<embed_new.pod> | ||
|
||
An overview of Parrot's embedding system. | ||
|
||
=item F<embed.pod> | ||
|
||
Describes the embedding subsystem in excruciating detail. | ||
|
||
=item F<extend.pod> | ||
|
||
A (mostly empty) description of Parrot's extension system. | ||
|
||
=item F<faq.pod> | ||
|
||
The Parrot FAQ. | ||
|
||
=item F<gettingstarted.pod> | ||
|
||
The Parrot Developer FAQ.[3] | ||
|
||
=item F<glossary.pod> | ||
|
||
A guide to some of the jargon which crops up repeatedly in Parrot development | ||
and throughout the documentation. | ||
|
||
=item F<html/> | ||
|
||
This subdirectory contains an html version of Parrot's Documentation Set. | ||
|
||
=item F<imcc/> | ||
|
||
This subdirectory contains documentation on Parrot's Intermediate Code | ||
Compiler (IMCC). | ||
|
||
=item F<index/> | ||
|
||
This subdirectory contains the json formatted files with which to generate | ||
Parrot's html Documentation Set. | ||
|
||
=item F<intro.pod> | ||
|
||
An introductory article on what Parrot is and how to do some interesting | ||
things with it. | ||
|
||
=item F<memory_internals.pod> | ||
|
||
An introduction to the Parrot GC subsystem | ||
|
||
=item F<multidispatch.pod> | ||
|
||
An (outdated document) on Parrot's multimethod dispatch for binary opcode | ||
functions. | ||
|
||
=item F<optable.pod> | ||
|
||
An ALPHA pod, describing the PGE operator precedence table and parser. | ||
|
||
=item F<overview.pod> | ||
|
||
An overview of Parrot's architecture and design. | ||
|
||
=item F<parrotbyte.pod> | ||
|
||
The Parrot bytecode format. | ||
|
||
=item F<parrothist.pod> | ||
|
||
A document which records Parrot source code releases, and their release | ||
managers. | ||
|
||
=item F<parrot.pod> | ||
|
||
A general document for the uninitiated which points to several "good starting | ||
points" throughout Parrot's Documentation Set. | ||
|
||
=item F<pct/> | ||
|
||
This subdirectory contains documentation on the Parrot Compiler Toolkit. | ||
|
||
=item F<pdds/> | ||
|
||
This subdirectory contains all of the current Parrot Design Documents (PDDs). | ||
PDDs are detailed guides to the design of the various Parrot subsystems, | ||
I<e.g.,> F<pdd03_calling_conventions.pod> specifies Parrot's inter-routine | ||
calling conventions. | ||
|
||
=item F<pmc/> | ||
|
||
This subdirectory contains documentation on several of the PMC types available | ||
to Parrot. | ||
|
||
|
||
=item F<pmc2c.pod> | ||
|
||
A document on the F<tools/build/pmc2c.pl> and how to use the tool to generate | ||
C code files from PMC definition files. | ||
|
||
=item F<pmc.pod> | ||
|
||
A general overview of PMC. | ||
|
||
=item F<porting_intro.pod> | ||
|
||
"This document is an introduction to porting the optional subsystems of Parrot | ||
onto a new architecture once the core successfully builds." | ||
|
||
=item F<project/> | ||
|
||
This subdirectory contains documentation important to Parrot Developers and | ||
administrators, I<e.g.,> F<docs/projects/release_manager_guide.pod>. | ||
|
||
=item F<req/> | ||
|
||
This subdirectory contains a document on "Model Users For Parrot Design | ||
Decisions."[4] | ||
|
||
=item F<resources/> | ||
|
||
This subdirectory contains various "resource" files, I<e.g.,> | ||
F<parrot_logo.png>, F<parrot.css>, etc. | ||
|
||
=item F<running.pod> | ||
|
||
Brief descriptions of the different executables and how to run them. | ||
|
||
=item F<stability.pod> | ||
|
||
"This document classifies Parrot components and interfaces based on their | ||
stability." | ||
|
||
=item F<submissions.pod> | ||
|
||
This is a document on "[h]ow to submit bug reports, patches and new files to | ||
Parrot." | ||
|
||
=item F<tests.pod> | ||
|
||
Hints on writing tests for the Parrot interpreter. | ||
|
||
=item F<translations/> | ||
|
||
This subdirectory contains multiple translations of Parrot's plaintext | ||
'README', I<e.g.,> F<README.deutsch>, F<README.espanol>, etc. | ||
|
||
=item F<user/> | ||
|
||
This subdirectory contains various documents of general interest to users, | ||
wanting to target Parrot. | ||
|
||
=item F<vtables.pod> | ||
|
||
A brief introduction to the vtable at the heart of all PMCs, and how to | ||
implement your own PMC type. | ||
|
||
=back | ||
|
||
=head1 NOTES | ||
|
||
[1] The contents of this 'README.pod' are, at present, tentative and, | ||
therefore, are subject to change. | ||
|
||
[2] We should change the name of this FAQ to better conform with the purpose | ||
of the FAQ. F<compiler_faq.pod> is far too ambiguous to be helpful. | ||
|
||
[3] We should change the name of this FAQ to better conform with the purpose | ||
of the FAQ. F<getttingstarted.pod> is far too general and implies something | ||
other than the Parrot Developer FAQ. | ||
|
||
[4] Is there any reason to retain this document? It seems, ten years later, | ||
more of a curiousity than an actual guide. | ||
|
||
=head1 COPYRIGHT | ||
|
||
Copyright (C) 2012, Parrot Foundation. | ||
|
||
=cut |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Copyright (C) 2001-2012, Parrot Foundation. | ||
|
||
=pod | ||
|
||
=head1 NAME | ||
|
||
docs/binaries/README.pod - Readme file for the 'docs/binaries/' directory. | ||
|
||
=head1 DESCRIPTION | ||
|
||
This directory contains the *.pod files to the installable binaries in the | ||
Parrot distribution. These files are also (or soon will be) used to generate | ||
*roff pages.[1] | ||
|
||
=head1 NOTES | ||
|
||
[1] The probable location and name of the conversion script will be, | ||
F<tools/docs/mk_pod2man.pl> | ||
|
||
=head1 COPYRIGHT | ||
|
||
Copyright (C) 2012, Parrot Foundation. | ||
|
||
=cut |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Copyright (C) 2011, Parrot Foundation. | ||
|
||
=head1 Name | ||
|
||
ops2c - Convert Parrot opcodes to C | ||
|
||
=head1 Description | ||
|
||
Translate Parrot opcode files (.ops) to C files. | ||
|
||
=head1 Usage | ||
|
||
ops2c [option] | ||
|
||
=head2 Command line Options | ||
|
||
For help, use : | ||
|
||
-h | ||
--help | ||
|
||
To generate the C code for core ops (must be run from within Parrot's build directory), use : | ||
|
||
-c | ||
--core | ||
|
||
To generate the C code for dynamic ops in a single .ops file, use : | ||
|
||
-d <file.ops> | ||
--dynamic <file.ops> | ||
|
||
To suppress error messages, use : | ||
|
||
-q | ||
--quiet | ||
|
||
To suppress #line directives in generated C code (line numbers are not currently supported), use : | ||
|
||
-n | ||
--no-lines | ||
|
||
For debugging option : | ||
To perform all processing without writing to any files, use : | ||
|
||
-g | ||
--debug | ||
|
||
=head1 Help | ||
|
||
For more help or any other question you go to L<http://parrot.org> or | ||
L<http://github.com/parrot/parrot>.Or you can send email to 'parrot-dev@parrot.org'. | ||
You are also invited to join the #parrot IRC channel on irc.parrot.org. | ||
|
||
=cut |
Oops, something went wrong.