Linux Certif

Toute la documentation sur la certification Linux LPI

Fedora::Bugzilla::Bug::Comment.3pm

As of Tue Dec 30 10:08:19 PST 2008, our xml comment snippet looks like:

<long_desc isprivate=``0''>
    <who name=``Chitlesh GOORAH''>cgoorah@yahoo.com.au</who>
    <bug_when>2008-12-21 08:53:23 ED/bug_when
    <thetext> Spec URL: http://chitlesh.fedorapeople.org/RPMS/perl-Hardware-Vhdl-Lexer.spec SRPM URL: http://chitlesh.fedorapeople.org/RPMS/perl-Hardware-Vhdl-Lexer-1.00-1.fc10.src.rpm Description: Hardware::Vhdl::Lexer splits VHDL code into lexical tokens. To use it, you need to first create a lexer object, passing in something which will supply chunks of VHDL code to the lexer. Repeated calls to the get_next_token method of the lexer will then return VHDL tokens (in scalar context) or a token type code and the token (in list context). get_next_token returns undef when there are no more tokens to be read.
    </thetext> </long_desc>

NAME

Fedora::Bugzilla::Bug::Comment - A bug comment

SYNOPSIS

         use <Module::Name>;
         # Brief but working code example(s) here showing the most common usage(s)
 
         # This section will be as far as many users bother reading
         # so make it as educational and exemplary as possible.
 
 

DESCRIPTION

A full description of the module and its features. May include numerous subsections (i.e. =head2, =head3, etc.)

SUBROUTINES/METHODS

A separate section listing the public components of the module's interface. These normally consist of either subroutines that may be exported, or methods that may be called on objects belonging to the classes that the module provides. Name the section accordingly.

In an object-oriented module, this section should begin with a sentence of the form ``An object of this class represents...'', to give the reader a high-level context to help them understand the methods that are subsequently described.

DIAGNOSTICS

A list of every error and warning message that the module can generate (even the ones that will ``never happen''), with a full explanation of each problem, one or more likely causes, and any suggested remedies.

CONFIGURATION AND ENVIRONMENT

A full explanation of any configuration system(s) used by the module, including the names and locations of any configuration files, and the meaning of any environment variables or properties that can be set. These descriptions must also include details of any configuration language used.

DEPENDENCIES

A list of all the other modules that this module relies upon, including any restrictions on versions, and an indication whether these required modules are part of the standard Perl distribution, part of the module's distribution, or must be installed separately.

INCOMPATIBILITIES

A list of any modules that this module cannot be used in conjunction with. This may be due to name conflicts in the interface, or competition for system or program resources, or due to internal limitations of Perl (for example, many modules that use source code filters are mutually incompatible).

SEE ALSO

...

BUGS AND LIMITATIONS

A list of known problems with the module, together with some indication whether they are likely to be fixed in an upcoming release.

Also a list of restrictions on the features the module does provide: data types that cannot be handled, performance issues and the circumstances in which they may arise, practical limitations on the size of data sets, special cases that are not (yet) handled, etc.

The initial template usually just has:

There are no known bugs in this module.

Please report problems to Chris Weyl <cweyl@alumni.drew.edu>, or (preferred) to this package's RT tracker at E<bug-Fedora-Bugzilla@rt.cpan.org>.

Patches are welcome.

AUTHOR

Chris Weyl <cweyl@alumni.drew.edu>

LICENSE AND COPYRIGHT

Copyright (c) 2008 Chris Weyl <cweyl@alumni.drew.edu>

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the

     Free Software Foundation, Inc.
     59 Temple Place, Suite 330
     Boston, MA  02111-1307  USA
 
 

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 31:

=begin without a target?

Around line 35:

Deleting unknown formatting code T<>

Around line 172:

Unknown E content in E<bug-Fedora-Bugzilla@rt.cpan.org>