The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
OODoc-2.02
River stage zero No dependents
1 ++
/ OODoc::Manifest

NAME

OODoc::Manifest - maintain the information inside a manifest file.

INHERITANCE

 OODoc::Manifest
   is an OODoc::Object

SYNOPSIS

 my $manifest = OODoc::Manifest->new(filename => ...);

DESCRIPTION

Extends "DESCRIPTION" in OODoc::Object.

OVERLOADED

Extends "OVERLOADED" in OODoc::Object.

overload: @{}

Referencing this object as array will produce all filenames from the manifest.

METHODS

Extends "METHODS" in OODoc::Object.

Constructors

Extends "Constructors" in OODoc::Object.

OODoc::Manifest->new(%options)
 -Option  --Default
  filename  undef
filename => FILENAME

The filename where the manifest is in. When the name is not defined, the data will not be written.

Inheritance knowledge

Extends "Inheritance knowledge" in OODoc::Object.

$obj->extends( [$object] )

Inherited, see "Inheritance knowledge" in OODoc::Object

Attributes

$obj->filename()

The name of the file which is read or will be written.

The manifest list

$obj->add($filenames)

Adds the $filenames to the manifest, doubles are ignored.

$obj->files()

Returns an unsorted list with all filenames in this manifest.

Internals

$obj->modified( [BOOLEAN] )

Whether filenames have been added to the list after initiation.

$obj->read()

Read the MANIFEST file. The comments are stripped from the lines.

$obj->relative($filename)

Returns the name of the file relative to the location of the MANIFEST file. The MANIFEST file should always be in top of the directory tree, so the $filename should be in the same directory and below.

$obj->write()

Write the MANIFEST file if it has changed. The file will automatically be written when the object leaves scope.

Commonly used functions

Extends "Commonly used functions" in OODoc::Object.

$obj->filenameToPackage($filename)
OODoc::Manifest->filenameToPackage($filename)

Inherited, see "Commonly used functions" in OODoc::Object

$obj->mkdirhier($directory)
OODoc::Manifest->mkdirhier($directory)

Inherited, see "Commonly used functions" in OODoc::Object

Manual Repository

Extends "Manual Repository" in OODoc::Object.

$obj->addManual($manual)

Inherited, see "Manual Repository" in OODoc::Object

$obj->mainManual($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->manual($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->manuals()

Inherited, see "Manual Repository" in OODoc::Object

$obj->manualsForPackage($name)

Inherited, see "Manual Repository" in OODoc::Object

$obj->packageNames()

Inherited, see "Manual Repository" in OODoc::Object

DIAGNOSTICS

Error: Cannot read manifest file $filename: $!

The manifest file could not be opened for reading.

Warning: MANIFEST file $name lists filename outside (sub)directory: $file

The MANIFEST file of a distributed package should be located in the top directory of that packages. All files of the distribution are in that same directory, or one of its sub-directories, otherwise they will not be packaged.

Error: manual definition requires manual object

A call to addManual() expects a new manual object (a OODoc::Manual), however an incompatible thing was passed. Usually, intended was a call to manualsForPackage() or mainManual().

SEE ALSO

This module is part of OODoc distribution version 2.02, built on December 08, 2021. Website: http://perl.overmeer.net/oodoc/

LICENSE

Copyrights 2003-2021 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the Artistic license. See http://dev.perl.org/licenses/artistic.html