/ 
File-Where-0.05
River stage zero No dependents
/ Docs::Site_SVD::File_Where

Title Page

Software Version Description

for

 File::Where - find the absolute file for a program module; dir for a repository

Revision: D

Version: 0.05

Date: 2004/05/04

Prepared for: General Public 

Prepared by:  SoftwareDiamonds.com E<lt> support@SoftwareDiamonds.com E<gt>

Copyright: copyright © 2003 Software Diamonds

Classification: NONE

1.0 SCOPE

This paragraph identifies and provides an overview of the released files.

1.1 Identification

This release, identified in 3.2, is a collection of Perl modules that extend the capabilities of the Perl language.

1.2 System overview

The system is the Perl programming language software. As established by the Perl referenced documents, program modules, such the "File::Where" module, extend the Perl language.

The subroutines in File::Where program module finds the absolute file or dir for a program module, program module repository, relative file, relative directory by searching the directories in the @INC array of directories or an override array of directories. The File::Where program module supercedes the File::PM2File program module.

1.3 Document overview.

This document releases File::Where version 0.05 providing a description of the inventory, installation instructions and other information necessary to utilize and track this release.

3.0 VERSION DESCRIPTION

All file specifications in this SVD use the Unix operating system file specification.

3.1 Inventory of materials released.

This document releases the file

File-Where-0.05.tar.gz

found at the following repository(s):

http://www.softwarediamonds/packages/
http://www.perl.com/CPAN/authors/id/S/SO/SOFTDIA/

Restrictions regarding duplication and license provisions are as follows:

Copyright.

copyright © 2003 Software Diamonds

603 882-0846 E<lt>support@SoftwareDiamonds.comE<gt>
License.

Software Diamonds permits the redistribution and use in source and binary forms, with or without modification, provided that the following conditions are met:

  1. Redistributions of source code, modified or unmodified must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

SOFTWARE DIAMONDS, http://www.SoftwareDiamonds.com, PROVIDES THIS SOFTWARE 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTWARE DIAMONDS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING USE OF THIS SOFTWARE, EVEN IF ADVISED OF NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE POSSIBILITY OF SUCH DAMAGE.

3.2 Inventory of software contents

The content of the released, compressed, archieve file, consists of the following files:

file                                                         version date       comment
------------------------------------------------------------ ------- ---------- ------------------------
lib/Docs/Site_SVD/File_Where.pm                              0.05    2004/05/04 revised 0.04
MANIFEST                                                     0.05    2004/05/04 generated, replaces 0.04
Makefile.PL                                                  0.05    2004/05/04 generated, replaces 0.04
README                                                       0.05    2004/05/04 generated, replaces 0.04
lib/File/Where.pm                                            1.16    2004/05/04 revised 1.15
t/File/Where.d                                               0.04    2004/05/04 revised 0.03
t/File/Where.pm                                              0.04    2004/05/04 revised 0.03
t/File/Where.t                                               0.04    2004/05/04 revised 0.03
t/File/_Drivers_/Driver.pm                                   0.02    2004/05/04 new
t/File/_Drivers_/Generate.pm                                 0.02    2004/05/04 new
t/File/_Drivers_/IO.pm                                       0.02    2004/05/04 new
t/File/File/Package.pm                                       1.16    2004/05/04 revised 1.15
t/File/Test/Tech.pm                                          1.22    2004/05/04 revised 1.17
t/File/Data/Secs2.pm                                         1.19    2004/05/04 revised 1.15
t/File/Data/SecsPack.pm                                      0.04    2004/05/04 new
t/File/Data/Startup.pm                                       0.04    2004/05/04 new

3.3 Changes

The changes to the previous version are as follows:

File-Where-0.01

Originated.

File-Where-0.02

Added code to where_pm for the boundary case where

where_pm('File::Where') # subroutine interface
'File::Where'->where_pm('File::Where') # class interface

This bug was discovered because the obsoleted File::PM2File module now uses File::Where for backwards compatibility.

File-Where-0.03
Subject: FAIL Test-Tech-0.18 i586-linux 2.4.22-4tr 
From: cpansmoke@alternation.net 
Date: Thu,  8 Apr 2004 15:09:35 -0300 (ADT) 

PERL_DL_NONLAZY=1 /usr/bin/perl5.8.0 "-MExtUtils::Command::MM" "-e" "test_harness(0, 'blib/lib', 'blib/arch')" t/Test/Tech/Tech.t
t/Test/Tech/Tech....Can't locate FindBIN.pm

Summary of my perl5 (revision 5.0 version 8 subversion 0) configuration:
  Platform:
    osname=linux, osvers=2.4.22-4tr, archname=i586-linux

This is capitalization problem. The program module name is 'FindBin' not 'FindBIN' which is part of Perl. Microsoft does not care about capitalization differences while linux does. This error is in the test script automatically generated by Test::STDmaker and was just introduced when moved test script libraries from tlib to the directory of the test script. Repaired Test::STDmaker and regenerated the distribution.

File-Where-0.04

Subject: FAIL File-Where-0.03 ppc-darwin-thread-multi 7.2.0 From: nothingmuch@woobling.org Date: Fri, 9 Apr 2004 21:59:10 +0300 (IDT)

# Test 19 got: '/private/var/cpanplus/5.8.3/build/File-Where-0.03/blib/lib/File/Where.pm' (t/File/where.t at line 277)

# Expected: '/private/var/cpanplus/5.8.3/build/File-Where-0.03/lib/File/Where.pm'

If doing a target site install, the install software going to place the blib directory up front in @INC Changed the file test to locate the include directory with high probability of having the first File::Where in the include path in determining the expected value.

Really does not cheapen test by doing a quasi where search where actual does the same. The object of the test to validate boundary condition where the class, 'File::Where', is the same as the program module 'File::Where that the 'where' subroutine/method is locating. There are plenty of successful test where where finds directories and files as expected.

File-Where-0.05

Rework the POD NOTES and QUALITY ASSURANCE sections.

File-Where-0.06

Added the is_module, program_modules, repository_pms and dir_pms subroutines.

3.4 Adaptation data.

This installation requires that the installation site has the Perl programming language installed. There are no other additional requirements or tailoring needed of configurations files, adaptation data or other software needed for this installation particular to any installation site.

There are no related documents needed for the installation and test of this release.

3.6 Installation instructions.

Instructions for installation, installation tests and installation support are as follows:

Installation Instructions.

To installed the release file, use the CPAN module pr PPM module in the Perl release or the INSTALL.PL script at the following web site:

http://packages.SoftwareDiamonds.com

Follow the instructions for the the chosen installation software.

If all else fails, the file may be manually installed. Enter one of the following repositories in a web browser:

http://www.softwarediamonds/packages/
http://www.perl.com/CPAN/authors/id/S/SO/SOFTDIA/

Right click on 'File-Where-0.05.tar.gz' and download to a temporary installation directory. Enter the following where $make is 'nmake' for microsoft windows; otherwise 'make'.

gunzip File-Where-0.05.tar.gz
tar -xf File-Where-0.05.tar
perl Makefile.PL
$make test
$make install

On Microsoft operating system, nmake, tar, and gunzip must be in the exeuction path. If tar and gunzip are not install, download and install unxutils from

http://packages.softwarediamonds.com
Prerequistes.
None.
Security, privacy, or safety precautions.

None.

Installation Tests.

Most Perl installation software will run the following test script(s) as part of the installation:

t/File/Where.t
Installation support.

If there are installation problems or questions with the installation contact

603 882-0846 E<lt>support@SoftwareDiamonds.comE<gt>

3.7 Possible problems and known errors

There is still much work needed to ensure the quality of this module as follows:

  • State the functional requirements for each method including not only the GO paths but also what to expect for the NOGO paths

  • All the tests are GO path tests. Should add NOGO tests.

4.0 NOTES

The following are useful acronyms:

.d

extension for a Perl demo script file

.pm

extension for a Perl Library Module

.t

extension for a Perl test script file

POD

Plain Old Documentation

2.0 SEE ALSO

File::Where
Docs::US_DOD::SVD






1 POD Error

The following errors were encountered while parsing the POD:

Around line 71:

Non-ASCII character seen before =encoding in '©'. Assuming CP1252