Title Page
     Software Version Description

     for

     ExtUtil::SVDmaker - Packaging modules for CPAN and Software Version Description (SVD) Automation

     Revision: C

     Version: 0.04

     Date: 2003/08/04

     Prepared for: General Public 

     Prepared by:  SoftwareDiamonds.com E<lt>support@SoftwareDiamonds.comE<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.

    The dependency of the program modules in the US DOD STD2167A bundle is
    as follows:

     File::TestPath File::Package File::SmartNL
       Text::Scrub
         Test::Tech

            DataPort::FileType::FormDB DataPort::DataFile DataPort::Maker Text::Replace
            Text::Column File::PM2File File::Data File::AnySpec File::SubPM

                Test::STDmaker ExtUtils::SVDmaker

    The top level modules that establish the functional interface of
    interest to the end user are the Test::STDmaker and the
    ExtUtils::SVDmaker modules. The rest of the modules in the above
    dependency tree are design modules for the US DOD STD2167A bundle. They
    are broken out as separate modules because they may be of use outside of
    the US DOD STD2167A bundle.

  1.3 Document overview.
    This document releases ExtUtils::SVDmaker version 0.04 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 found at the following repository(s):

       http://www.softwarediamonds/packages/ExtUtils-SVDmaker-0.04
       http://www.perl.com/CPAN-local/authors/id/S/SO/SOFTDIA/ExtUtils-SVDmaker-0.04

    Restrictions regarding duplication and license provisions are as
    follows:

    Copyright.
        copyright © 2003 Software Diamonds

    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:

        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/ExtUtils_SVDmaker.pm                       0.04    2003/08/04 revised 0.03
     MANIFEST                                                     0.04    2003/08/04 generated, replaces 0.03
     Makefile.PL                                                  0.04    2003/08/04 generated, replaces 0.03
     README                                                       0.04    2003/08/04 generated, replaces 0.03
     lib/ExtUtils/SVDmaker.pm                                     1.06    2003/08/04 revised 1.05
     bin/vmake.pl                                                 1.04    2003/08/04 revised 1.03
     t/ExtUtils/SVDmaker/SVDmaker.d                               0.04    2003/08/04 revised 0.03
     t/ExtUtils/SVDmaker/SVDmaker.pm                              0.04    2003/08/04 revised 0.03
     t/ExtUtils/SVDmaker/SVDmaker.t                               0.04    2003/08/04 revised 0.03
     t/ExtUtils/SVDmaker/lib/SVDtest1.pm                          0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/lib/SVDtest1.t                           0.02    2003/08/04 new
     tlib/Test/Tech.pm                                            1.12    2003/08/04 unchanged
     tlib/File/SmartNL.pm,                                        1.12    2003/08/04 revised 1.11
     t/ExtUtils/SVDmaker/expected/Makefile                        0.04    2003/08/04 new
     t/ExtUtils/SVDmaker/expected/Makefile2.PL                    0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/Makefile3.PL                    0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/MANIFEST2                       0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/module0A.pm                     0.04    2003/08/04 new
     t/ExtUtils/SVDmaker/expected/module0B.pm                     0.04    2003/08/04 new
     t/ExtUtils/SVDmaker/expected/module2.pm                      0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/README2                         0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/README3                         0.04    2003/08/04 revised 0.03
     t/ExtUtils/SVDmaker/expected/SVDmaker0.pm                    0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/SVDtest-0.01.html               0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/SVDtest.ppd                     0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/SVDtest0A.pm                    0.04    2003/08/04 new
     t/ExtUtils/SVDmaker/expected/SVDtest0A.t                     0.04    2003/08/04 new
     t/ExtUtils/SVDmaker/expected/SVDtest0B.pm                    0.04    2003/08/04 new
     t/ExtUtils/SVDmaker/expected/SVDtest0B.t                     0.04    2003/08/04 new
     t/ExtUtils/SVDmaker/expected/SVDtest2-0.01.html              0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/SVDtest2.pm                     0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/SVDtest2.ppd                    0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/SVDtest2.t                      0.04    2003/08/04 new
     t/ExtUtils/SVDmaker/expected/SVDtest3-0.02.html              0.03    2003/08/04 revised 0.02
     t/ExtUtils/SVDmaker/expected/SVDtest3.pm                     0.04    2003/08/04 revised 0.03
     t/ExtUtils/SVDmaker/expected/SVDtest3.ppd                    0.03    2003/08/04 revised 0.02

  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.

  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.

  3.5 Related documents.
    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.
        Follow the general Perl software installation procedure to install
        the files contained in this distribution file.

        The distribution name and version are as follows:

         distribution name: ExtUtils-SVDmaker
         version          : 0.04

    Prerequistes.
         'DataPort::FileType::FormDB' => '0.03',
         'DataPort::Maker' => '1.04',
         'DataPort::DataFile' => '0.04',
         'Text::Scrub' => '0',
         'Text::Replace' => '0',
         'Text::Column' => '0',
         'File::AnySpec' => '0',
         'File::Package' => '0',
         'File::Data' => '0',

    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/SVDmaker.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
    Modules with end-user functional interfaces relating to US DOD 2167A
    automation are as follows:

    Test::STDmaker
    ExtUtils::SVDmaker
    DataPort::FileType::FormDB
    DataPort::DataFile
    Test::Tech
    Test
    Data::Dumper
    Test::STD::Scrub
    Test::STD::STDutil
    File::FileUtil

    The design modules for Test::STDmaker have no other conceivable use then
    to support the Test::STDmaker functional interface. The Test::STDmaker
    design module are as follows:

    Test::STD::Check
    Test::STD::FileGen
    Test::STD::STD2167
    Test::STD::STDgen
    Test::STDtype::Demo
    Test::STDtype::STD
    Test::STDtype::Verify

    Some US DOD 2167A Software Development Standard, DIDs and other related
    documents that complement the US DOD 2167A automation are as follows:

    US DOD Software Development Standard
    US DOD Specification Practices
    Computer Operation Manual (COM) DID
    Computer Programming Manual (CPM) DID)
    Computer Resources Integrated Support Document (CRISD) DID
    Computer System Operator's Manual (CSOM) DID
    Database Design Description (DBDD) DID
    Engineering Change Proposal (ECP) DID
    Firmware support Manual (FSM) DID
    Interface Design Document (IDD) DID
    Interface Requirements Specification (IRS) DID
    Operation Concept Description (OCD) DID
    Specification Change Notice (SCN) DID
    Software Design Specification (SDD) DID
    Software Development Plan (SDP) DID
    Software Input and Output Manual (SIOM) DID
    Software Installation Plan (SIP) DID
    Software Programmer's Manual (SPM) DID
    Software Product Specification (SPS) DID
    Software Requirements Specification (SRS) DID
    System or Segment Design Document (SSDD) DID
    System or Subsystem Specification (SSS) DID
    Software Test Description (STD) DID
    Software Test Plan (STP) DID
    Software Test Report (STR) DID
    Software Transition Plan (STrP) DID
    Software User Manual (SUM) DID
    Software Version Description (SVD) DID
    Version Description Document (VDD) DID

