# Copyright (C) 2004-2006, The Perl Foundation.
# $Id: /mirror/trunk/lib/Parrot/Docs/Section/Info.pm 33795 2008-12-10T15:21:06.410153Z coke  $

=head1 NAME

Parrot::Docs::Section::Info - Project info documentation section

=head1 SYNOPSIS

    use Parrot::Docs::Section::Info;

=head1 DESCRIPTION

A documentation section describing Parrot's project info.

=head2 Class Methods

=over

=cut

package Parrot::Docs::Section::Info;

use strict;
use warnings;

use base qw( Parrot::Docs::Section );

=item C<new()>

Returns a new section.

=cut

sub new {
    my $self = shift;

    return $self->SUPER::new(
        'Project Information',
        'info.html',
'The conventional, generally all-caps, project information files which contain assorted bits and pieces of information about the distribution.',
        $self->new_group(
            'Documentation',
            '',
            $self->new_item(
                'General information about licences, prerequisites, and building instructions.',
                'README'
            ),
            $self->new_item(
                'Instructions for Parrot in a cygwin environment.', 'README_cygwin.pod'
            ),
            $self->new_item(
                'Instructions for Parrot in a Win32 environment.', 'README_win32.pod'
            ),
            $self->new_item( 'This file lists what\'s new in each version.', 'NEWS' ),
            $self->new_item( 'Where to find or put things that need doing in Parrot.', 'TODO' ),
            $self->new_item(
'This is a description of the steps someone should follow when they have to prepare a new version for release.',
                'docs/project/release_manager_guide.pod'
            ),
        ),
        $self->new_group(
            'Legal', '',
            $self->new_item( 'The licence under which Parrot is distributed.', 'LICENSE' ),
        ),
        $self->new_group(
            'Status', '',
            $self->new_item(
                'A table showing which aspects of Parrot run on various platforms.', 'PLATFORMS'
            ),
            $self->new_item( 'Contains the version number of the distribution.', 'VERSION' ),
            do {
                -e '../DEVELOPING'
                    ? $self->new_item(
'The presence of this file indicates that the distribution is a development version.',
                    'DEVELOPING'
                    )
                    : ();
            },
            $self->new_item( 'The status of the Parrot test suite.', 't/TESTS_STATUS.pod' ),
        ),
        $self->new_group(
            'People',
            '',
            $self->new_item(
                'A list of some of the Parrot developers with SVN commit access.',
                'RESPONSIBLE_PARTIES'
            ),
            $self->new_item(
                'A list of some of people who have contributed to Parrot.', 'CREDITS'
            ),
        ),
        $self->new_group(
            'Contents',
'See the <code>ExtUtils::Manifest</code> documentation for more information about MANIFEST files.',
            $self->new_item(
                'Lists all the files in the distribution, with their metadata.', 'MANIFEST'
            ),
            $self->new_item(
'Lists all the generated files, i.e. the files that will be added to the distribution after configuration and installing.',
                'MANIFEST.generated'
            ),
            $self->new_item( 'Specifies the files to leave out of MANIFEST.', 'MANIFEST.SKIP' ),
        ),
        $self->new_group(
            'History',
            '',
            $self->new_item( 'The Parrot history records', 'docs/parrothist.pod' ),
            $self->new_item( 'Provide a timeline of changes made to the project.', 'ChangeLog' ),
            $self->new_item(
'Documents incompatible changes to Parrot that invalidate existing bytecode files. This is the new experimental alternative to the fingerprint produced by tools/build/fingerprint_c.pl.',
                'PBC_COMPAT'
            ),
        ),
    );
}

=back

=cut

1;

# Local Variables:
#   mode: cperl
#   cperl-indent-level: 4
#   fill-column: 100
# End:
# vim: expandtab shiftwidth=4:
