File Coverage

blib/lib/Perl6/Doc.pm

Criterion	Covered	Total	%
statement	8	8	100.0
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	12	12	100.0

line	stmt	sub	time	code
1				package Perl6::Doc;
2				BEGIN {
3	1	1	1031	$Perl6::Doc::AUTHORITY = 'cpan:HINRIK';
4				}
5				BEGIN {
6	1	1	18	$Perl6::Doc::VERSION = '0.47';
7				}
8	1	1	9	use strict;
	1		2
	1		38
9	1	1	5	use warnings FATAL => 'all';
	1		14
	1		81
10
11				1;
12
13				=encoding utf8
14
15				=head1 NAME
16
17				Perl6::Doc - Perl 6 documentation
18
19				=head1 SYNOPSIS
20
21				This distribution is documentation-only. It contains no code for you to run.
22				Included are various Perl 5 Pod and Perl 6 Pod files describing the Perl 6
23				language. For a tool to read this documentation, see L.
24
25				=head1 DESCRIPTION
26
27				Currently included in this distribution:
28
29				=head2 Design docs
30
31				=head3 Apocalypses (outdated)
32
33				Larry Wall started the Apocalypse (latin for revelation) series as a
34				systematic way of answering the RFCs (Request For Comments) that
35				started the design process for Perl 6. Each Apocalypse corresponds to
36				a chapter in the book I, and addresses
37				the features relating to that chapter in the book that are likely to
38				change.
39
40				Larry addresses each relevant RFC, and gives reasons why he accepted
41				or rejected various pieces of it. But each Apocalypse also goes
42				beyond a simple "yes" and "no" response to attack the roots of the
43				problems identified in the RFCs.
44
45				B These documents are outdated and and will not be updated to match
46				the specification (see L).
47
48				=head3 Exegeses (outdated)
49
50				Damian Conway's Exegeses (latin for I) are extensions of
51				each Apocalypse. Each Exegesis is built around a practical code
52				example that applies and explains the new ideas.
53
54				B These documents are outdated and and will not be updated to match
55				the specification (see L).
56
57				=head3 Synopses
58
59				The Synopsis (latin for comparison) started as a fast to read diff
60				between Perl 5 and 6. Because they are also easier to maintain, all
61				changes of the language, that are evolving from the design process
62				are written down here first. The Apocalypses and Exegeses are frozen
63				as "historic documents".
64
65				In other words, these docs may change slightly or radically. But the
66				expectation is that they are "very close" to the final shape of Perl 6.
67
68				The Synopsis documents are to be taken as the formal specification for
69				Perl 6 implementations, while still being reference documentation for
70				Perl 6, like I is for Perl 5.
71
72				Note that while these documents still being subjected to the rigours
73				of cross-examination through implementation.
74
75				=head2 Magazine articles
76
77				These are Pod-ified versions of magazine articles about Perl 6 that have
78				appeared in print during the design process. Take these with a grain of salt
79				as they might not describe Perl 6 as it is now. They are mostly from
80				L and L.
81
82				=head2 Perl 6 Table Index
83
84				A Pod-ified version of L
85				is included.
86
87				=head2 Man pages
88
89				Currently included are draft versions of F and F.
90
91				=head1 HISTORY
92
93				As of version 0.40, this distribution has been overhauled and is no longer
94				maintained by Herbert Breunung, who originally took it over from ingy and
95				audreyt.
96
97				=head1 PACKAGING
98
99				Hinrik Örn Sigurðsson, L
100
101				I'm not the author of the documentation in this distro, of course, I merely
102				maintain this package.
103
104				=head1 SOURCES
105
106				All Apocalypses and Exegeses were taken from the official Perl development
107				site: L
108
109				All Synopese were taken from the Pugs repository:
110				L
111
112				The magazine articles are from perl.com:
113				L
114
115				=head1 LICENSE AND COPYRIGHT
116
117				This copyright applies only to the C Perl software
118				distribution, not the documents bundled within.
119
120				Copyright (c) 2009, Hinrik Örn Sigurðsson L.
121
122				C is distributed under the terms of the Artistic License 2.0.
123				For more details, see the full text of the license in the file F
124				that came with this distribution.
125
126				=head2 Scribes
127
128				These are the authors of the included docs, named in the order their work
129				was added. This list is not exhaustive.
130
131				* Larry Wall L
132
133				* Damian Conway L
134
135				* Luke Palmer L
136
137				* Allison Randal L
138
139				* Audrey Tang L
140
141				* Ingy döt Net L
142
143				* Sam Vilain L
144
145				* Kirrily "Skud" Robert L
146
147				* Moritz Lenz L
148
149				* David Koenig L
150
151				* Jonathan Scott Duff L
152
153				* Phil Crow L
154
155				* chromatic L
156
157				* Mark-Jason Dominus L
158
159				* Shmarya L
160
161				* Pawel Murias L<13pawel@gazeta.pl>
162
163				* Herbert Breunung L
164
165				=cut