NAME

Docs::Site_SVD::ExtUtils_SVDmaker - Create CPAN distributions

Title Page

Software Version Description

for

Docs::Site_SVD::ExtUtils_SVDmaker - Create CPAN distributions

Revision: J

Version: 0.10

Date: 2004/05/25

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, the "ExtUtils::SVDmaker" program module extends the Perl language.

The "ExtUtils::SVDmaker" module extends the automation of releasing a Perl distribution file as follows:

The input data for the "ExtUtils::SVDmaker" module is a form database in the __DATA__ section of the SVD program module. The database is in the format of DataPort::FileType::FormDB. This is an efficient text database that is very close in format to hard copy forms and may be edited by text editors
The "ExtUtils::SVDmaker" module compares the contents of the current release with the previous release and automatically updates the version and date for files that have changed
"ExtUtils::SVDmaker" module generates a SVD program module POD from the form database data contained in the __DATA__ section of the SVD program module.
"ExtUtils::SVDmaker" module generates the MANIFEST, README and Makefile.PL distribution files from the form database data
"ExtUtils::SVDmaker" module builds the distribution *.tar.gz file using Perl code instead of starting tar and gzip process via a makefile build by MakeFile.PL. This greatly increases portability and performance.
Runs the installation tests on the distribution files using the "Test::Harness" module directly. It does not build any makefile using the MakeFile.PL and starting a Test::Harness process via the makefile. This greatly increases portability and performance.

The ExtUtils::SVDmaker module is one of the end user, functional interface modules for the US DOD STD2167A bundle. Two STD2167A bundle end user modules are as follows:

Test::STDmaker module: generates Test script, demo script and STD document POD from a text database in the Data::Port::FileTYpe::FormDB format.
ExtUtils::SVDmaker module: generates SVD document POD and distribution *.tar.gz file including a generated Makefile.PL README and MANIFEST file from a text database in the Data::Port::FileTYpe::FormDB format.

1.3 Document overview.

This document releases ExtUtils::SVDmaker version 0.10 providing 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

ExtUtils-SVDmaker-0.10.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 holder contact.

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

License.

These files are a POD derived works from the hard copy public domain version freely distributed by the United States Federal Government.

The original hardcopy version is always the authoritative document and any conflict between the original hardcopy version governs whenever there is any conflict. In more explicit terms, any conflict is a transcription error in converting the origninal hard-copy version to this POD format. Software Diamonds assumes no responsible for such errors.

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

Redistributions of source code, modified or unmodified must retain the above copyright notice, this list of conditions and the following disclaimer.
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.
Commercial installation of the binary or source must visually present to the installer the above copyright notice, this list of conditions intact, that the original source is available at http://softwarediamonds.com and provide means for the installer to actively accept the list of conditions; otherwise, a license fee must be paid to Softwareware Diamonds.

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/ExtUtils_SVDmaker.pm                       0.10    2004/05/25 revised 0.09
MANIFEST                                                     0.10    2004/05/25 generated, replaces 0.09
Makefile.PL                                                  0.10    2004/05/25 generated, replaces 0.09
README                                                       0.10    2004/05/25 generated, replaces 0.09
lib/ExtUtils/SVDmaker.pm                                     1.12    2004/05/25 revised 1.11
t/ExtUtils/SVDmaker/Original.d                               0.01    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Original.pm                              0.01    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Original.t                               0.01    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Revise.d                                 0.01    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Revise.pm                                0.01    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Revise.t                                 0.01    2004/05/25 unchanged
t/ExtUtils/SVDmaker/vmake.pl                                 1.04    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Test/Tech.pm                             1.26    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Text/Scrub.pm                            1.17    2004/05/25 new
t/ExtUtils/SVDmaker/Data/Secs2.pm                            1.26    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Data/Str2Num.pm                          0.08    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Data/Startup.pm                          0.07    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Test.pm                                  0.10    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Algorithm/Diff.pm                        0.10    2004/05/25 unchanged
t/ExtUtils/SVDmaker/Pod/Text.pm                              0.10    2004/05/25 unchanged
t/ExtUtils/SVDmaker/expected/Makefile                        0.04    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/Makefile2.PL                    0.03    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/Makefile3.PL                    0.03    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/MANIFEST2                       0.04    2004/05/11 unchanged
t/ExtUtils/SVDmaker/expected/module0A.pm                     0.04    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/module0B.pm                     0.04    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/module2.pm                      0.03    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/README2                         0.05    2004/05/13 unchanged
t/ExtUtils/SVDmaker/expected/README3                         0.06    2004/05/13 unchanged
t/ExtUtils/SVDmaker/expected/SVDmaker0.pm                    0.03    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest-0.01.html               0.03    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest.ppd                     0.03    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest0A.pm                    0.05    2004/05/11 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest0A.t                     0.05    2004/05/11 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest0B.pm                    0.05    2004/05/11 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest0B.t                     0.05    2004/05/11 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest1-0.01.tar.gz            0.09    2004/05/25 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest1.ppd                    0.09    2004/05/25 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest2-0.01.html              0.03    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest2.pm                     0.05    2004/05/13 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest2.ppd                    0.04    2004/05/11 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest2.t                      0.04    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest3-0.02.html              0.03    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest3.pm                     0.06    2004/05/13 unchanged
t/ExtUtils/SVDmaker/expected/SVDtest3.ppd                    0.03    2003/08/04 unchanged
t/ExtUtils/SVDmaker/expected/Test/Tech.pm                    0.05    2004/05/11 unchanged
t/ExtUtils/SVDmaker/expected/Data/Secs2.pm                   0.05    2004/05/11 unchanged
t/ExtUtils/SVDmaker/expected/Data/SecsPack.pm                0.05    2004/05/11 unchanged
t/ExtUtils/SVDmaker/expected/Data/Startup.pm                 0.05    2004/05/11 unchanged
t/ExtUtils/SVDmaker/expected/File/Package.pm                 0.05    2004/05/11 unchanged

3.3 Changes

Changes are as follows:

ExtUtils::SVDmaker-0.01

Change the name from SVD::SVDmaker to ExtUtils::SVDmaker. The CPAN keepers have a no new top levels unless absolutely necessary policy.

Added tests.

ExtUtils::SVDmaker-0.02

Drop tailing and starting white space for SEE_ALSO. Extra lines feeds was causing pod2hmtl to misbehave and not pick up on " links ".

Fixed error in calculation of $formDB->{PM_File_Relative}

Removed requirement for external Unix commands. Added code to replace the extenal Unix commands. The is no longer the need for nmake, make, tar, gzip, gunzip.

Change the test so that test support program modules resides in distribution directory tlib directory instead of the lib directory. Because they are no longer in the lib directory, test support files will not be installed as a pre-condition for the test of this module. The test of this module will precede immediately. The test support files in the tlib directory will vanish after the installtion.

ExtUtils::SVDmaker-0.03

Fix some more problems due to Archive::Tar does tar correctly, (length of file contents does not match length in header) when use non Unix "\n"

ExtUtils::SVDmaker-0.04

Broke out the tar and gzip software into the modules Archive::TarGzip. Hopefully dealing with the Text '\n' problem by isolating and testing these functions separately. They also have high probability of being useful outside this module.

ExtUtils::SVDmaker-0.05

The lastest build of Test::STDmaker expects the test library in the same directory as the test script. Coordiated with the lastest Test::STDmaker by moving the test library from tlib to t/ExtUtils, the same directory as the test script and deleting the test library File::TestPath program module.

Added addition code to the test target to isolate the program module under test. Before the test, the @INC directories are stipped back to the first one contain Perl. This is to isolate the test to only the virgin Perl distribution program modules. The test target then creates a require directory under the same directory as the test script and copies over all prequesite program modules to this directory. After the test target performs the test it restores @INC and removes the require directory tree.

Hopefully this will eliminate many time consuming distributions failure due to using program modules that that are not part of the distributions.

SWitch from DataPort::Maker to File::Maker. Eliminated the use of File::Data and File::TestPath

ExtUtils::SVDmaker-0.06

Verbatim NAME section from template. Replaced.

ExtUtils::SVDmaker-0.07

Escape the SVD template POD '=' commands so that they do not confuse the CPAN to which is the real POD.

ExtUtils::SVDmaker-0.08

Fixed typo in the NAME section.

ExtUtils::SVDmaker-0.09

Subject: FAIL ExtUtils-SVDmaker-0.08 sparc-linux 2.4.21-pre7 
From: alian@cpan.org (alian)

TEST 9 FAILURE

t/ExtUtils/SVDmaker/SVDmaker....# Test 9 got: 'NAME

[snip]

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.

[snip] 

' (t/ExtUtils/SVDmaker/SVDmaker.t at line 265)
#   Expected: 'NAME

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.

[snip]

TEST 10 FAILURE

# Test 10 got: '<SOFTPKG NAME="SVDtest1" VERSION="0,01,0,0">
[snip]
               <OS NAME="linux" />
[snip]
</SOFTPKG>
' (t/ExtUtils/SVDmaker/SVDmaker.t at line 272)
#    Expected: '<SOFTPKG NAME="SVDtest1" VERSION="0,01,0,0">
[snip]
               <OS NAME="MSWin32" />
[snip]
</SOFTPKG>

TEST 12 FAILURE

# Test 12 got: <UNDEF> (t/ExtUtils/SVDmaker/SVDmaker.t at line 315)
#    Expected: '1' (Required SVD DB field, DISTNAME, missing.
#Use of uninitialized value in substitution (s///) at /home/alian/.cpanplus/5.8.4/build/ExtUtils-SVDmaker-0.08/blib/lib/ExtUtils/SVDmaker.pm line 489, <DATA> line 698.

ExtUtils::SVDmaker-0.10

Failure:

Failuring test 10 of both original.t test script and the revise.t test script.

Subject: FAIL ExtUtils-SVDmaker-0.09 ppc-linux 2.4.19-4a 
From: alian@cpan.org (CPAN Tester + CPAN++ automate) 
t/ExtUtils/SVDmaker/Original....# Test 10 got: 

[snip]

#     - "\t\t<OS NAME=\"MSWin32\" />\n"
#     + "\t\t<OS NAME=\"linux\" />\n"

[snip]

Analysis:

Not using the lastest version of Test::Scrub which will wild card out OS NAME

Corrective:

Put lastest version in ExtUtils::SVDmaker use, the Makerfile.PL prerequesite and also load the lastes in the test t::Test::ExtUtils::SVDmaker repository. (Quite a few times CPAN package does not handle prereuesites as expected)

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 package, 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 'ExtUtils-SVDmaker-0.10.tar.gz' and download to a temporary installation directory. Enter the following where $make is 'nmake' for microsoft windows; otherwise 'make'.

gunzip ExtUtils-SVDmaker-0.10.tar.gz
tar -xf ExtUtils-SVDmaker-0.10.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

VERY IMPORTANT:

The distribution package contains the cover vmake.pl perl command script. Manually copy this into the execution path in order to use SVDmaker from the command line. Rename it if there is a name conflict or just do not like the name.

Prerequistes.

'Archive::TarGzip' => '0.03',
'File::AnySpec' => '1.13',
'File::Maker' => '0.03',
'File::Package' => '1.16',
'File::SmartNL' => '1.14',
'File::Where' => '0',
'Text::Replace' => '0',
'Text::Column' => '0',
'Text::Scrub' => '1.17',
'Tie::Form' => '0.01',
'Tie::Layers' => '0.04',
'Tie::Gzip' => '1.15',

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/ExtUtils/SVDmaker/Original.t
t/ExtUtils/SVDmaker/Revise.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

Open issues are as follows:

Should format $svd->{PREREQ_PM_TEXT} into a table.
Need to generted the requirements and add the addressed requirements to the tests.

4.0 NOTES

This document uses the following acronyms:

.d: extension for a Perl demo script file
.pm: extension for a Perl Library Module
.t: extension for a test file
DID: Data Item Description
DOD: Department of Defense
POD: Plain Old Documentation
SVD: Software Version Description
STD: Software Test Description
US: United States

2.0 SEE ALSO

ExtUtils::SVDmaker
Test::STDmaker
Test::Tech
Test
File::Maker
Tie::Form
Tie::Layers
Text::Column
Text::Replace
Text::Scrub
Specification Practices
Software Development
Software Version Description (SVD) DID

1 POD Error

The following errors were encountered while parsing the POD:

Around line 376:: L<> starts or ends with whitespace

To install ExtUtils::SVDmaker, copy and paste the appropriate command in to your terminal.

cpanm

cpanm ExtUtils::SVDmaker

CPAN shell

perl -MCPAN -e shell
install ExtUtils::SVDmaker

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)