Software Version Description for Software Development Standards, Specifications and Data Item Description PODs Revision: E Version: 0.06 Date: 2003/09/15 Prepared for: General Public Prepared by: SoftwareDiamonds.com E<lt>support@SoftwareDiamonds.comE<gt> Copyright: copyright © 2003 Software Diamonds Classification: NONE
This paragraph identifies and provides an overview of the released files.
This release, identified in 3.2, is a collection of Perl modules that extend the capabilities of the Perl language.
This release adds United States Department of Defense (US DOD) Perl Plain Old Documentation (POD) derived from software related documents release by the US DOD to the general public.
These documents and the terminology used in these documents govern much of the Software Development including design, test, distribution, release, installation and use of software.
One area of praticular interest is development software that automates development tasks freeing up designers, technicians and other personell to concentrate on key development tasks.
Toward this end, two starting modules that make heavy references to the these 2167A documents are the following modules:
Generates 2167A STD DID, demonstration script, and test script from a STD text database in a format consistent with DataPort::FileType::FormDB.
Generates 2167A SVD DID, MakeFile.PL, README, MANIFEST, updates file versions and creates .tar.gz distribution file from a SVD text database in a format consistent with DataPort::FileType::FormDB.
The dependency of the program modules in the US DOD STD2167A bundle is as follows:
File::Package File::SmartNL File::TestPath Text::Scrub Test::Tech DataPort::FileType::FormDB DataPort::DataFile DataPort::Maker File::AnySpec File::Data File::PM2File File::SubPM Text::Replace Text::Column Test::STDmaker ExtUtils::SVDmaker
This document releases Docs-US_DOD-STD2167A version 0.06 and provides a description of the inventory, installation instructions and other information necessary to utilize and track this release.
All file specifications in this SVD use the Unix operating system file specification.
This document releases the file found at the following repository(s):
http://www.softwarediamonds/packages/Docs-US_DOD-STD2167A-0.06 http://www.perl.com/CPAN-local/authors/id/S/SO/SOFTDIA/Docs-US_DOD-STD2167A-0.06
Restrictions regarding duplication and license provisions are as follows:
copyright © 2003 Software Diamonds
603 882-0846 E<lt>support@SoftwareDiamonds.comE<gt>
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.
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.
The content of the released, compressed, archieve file, consists of the following files:
file version date comment ------------------------------------------------------------ ------- ---------- ------------------------ lib/Docs/Site_SVD/Docs_US_DOD_STD2167A.pm 0.06 2003/09/15 revised 0.05 MANIFEST 0.06 2003/09/15 generated, replaces 0.05 Makefile.PL 0.06 2003/09/15 generated, replaces 0.05 README 0.06 2003/09/15 generated, replaces 0.05 lib/Docs/US_DOD/CDRL.pm 1.07 2003/07/05 unchanged lib/Docs/US_DOD/COM.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/CPM.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/CRISD.pm 1.07 2003/09/15 revised 1.06 lib/Docs/US_DOD/CSCI.pm 1.06 2003/06/10 unchanged lib/Docs/US_DOD/CSOM.pm 1.07 2003/09/15 revised 1.06 lib/Docs/US_DOD/DBDD.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/ECP.pm 1.06 2003/06/10 unchanged lib/Docs/US_DOD/FSM.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/HWCI.pm 1.06 2003/06/10 unchanged lib/Docs/US_DOD/IDD.pm 1.07 2003/09/15 revised 1.06 lib/Docs/US_DOD/IRS.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/OCD.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/SCN.pm 1.06 2003/06/10 unchanged lib/Docs/US_DOD/SDD.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/SDP.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/SDR.pm 1.06 2003/06/10 unchanged lib/Docs/US_DOD/SIOM.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/SIP.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/SPM.pm 1.06 2003/06/10 unchanged lib/Docs/US_DOD/SPS.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/SRS.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/SSDD.pm 1.06 2003/06/10 unchanged lib/Docs/US_DOD/SSS.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/STD.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/STD2167A.pm 1.08 2003/06/14 unchanged lib/Docs/US_DOD/STD490A.pm 1.08 2003/06/14 unchanged lib/Docs/US_DOD/STP.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/STR.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/STrP.pm 1.07 2003/06/10 unchanged lib/Docs/US_DOD/SUM.pm 1.08 2003/06/14 unchanged lib/Docs/US_DOD/SVD.pm 1.08 2003/06/10 unchanged lib/Docs/US_DOD/VDD.pm 1.07 2003/09/15 revised 1.06 t/Docs/US_DOD/STD2167A.t 0.07 2003/07/05 unchanged
Changes are as follows:
Version 0.02 loaded test file t/Docs/US_DOD/STD2167A.t but specified test file t/docs/US_DOD/STD2167A.t. Works on case insensitive file specs OS such as MsDOS but fails on case sensitive file specs OS such as Unix
Changed the test file
From:
t/docs/US_DOD/STD2167A.t
To:
t/Docs/US_DOD/STD2167A.t
Another case insensitive issue. The STrP has one lower case letter. Make changes so everything should match the case. Unix file specifications are case sensitive while Microsoft's are not.
Deleted SRR and SDR which since they are review, have not document.
Supplied contents for the following
VDD.pm CRISD.pm CSOM.pm IDD.pm
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.
Instructions for installation, installation tests and installation support are as follows:
To installed the release file, use the CPAN 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.
The distribution file is at the following respositories:
'File::Package' => '0',
None.
Most Perl installation software will run the following test script(s) as part of the installation:
If there are installation problems or questions with the installation contact
None of the PODs contain any of the figures from the hard-copy versions. The following PODs do not contain any documents and an empty POD is included only to resolve links when the converted documents converted to PODs cites documents not converted to PODs:
CDRL.pod CSCI.pod ECP.pod HWCI.pod SCN.pod SPM.pod SSD.pod
For Perl module releases, these documents may not be applicable. Many of them are for large software applications and complex systems involving both hardware and software while others establish format, legally binding, contractual requirements between the supplier and consumer of the data. Neither of these apply for this document.
The following are useful acronyms:
extension for a Perl Library Module
extension for a Perl test script file
Data Item Description
Plain Old Documentation
extension for a Software Vesion Description database file
Modules with end-user functional interfaces relating to US DOD 2167A automation are as follows:
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:
Some US DOD 2167A Software Development Standard, DIDs and other related documents that complement the US DOD 2167A automation are as follows:
1 POD Error
The following errors were encountered while parsing the POD:
Non-ASCII character seen before =encoding in '©'. Assuming CP1252
To install Docs::US_DOD::SDD, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Docs::US_DOD::SDD
CPAN shell
perl -MCPAN -e shell install Docs::US_DOD::SDD
For more information on module installation, please visit the detailed CPAN module installation guide.