[CAMP-239] Confusing use of "archive" in 4.1, 4.1.1 and following. - OASIS Technical Committees Issue Tracker

Details

Type: Bug
Status: Applied
Priority: Major
Resolution: Fixed
Affects Version/s: 1.2
Fix Version/s: 1.2
Component/s: Spec
Labels:
None
Environment:

Style

Proposal:

Hide

Try this:

*****
A PDP is a directory structure which contains a Plan file named camp.yaml at its root. A PDP May contain sub-directories and other files including, but not limited to, language-specific bundles, resource files, application content files such as web archives, database schemas, scripts, source code, localization bundles, and icons; and metadata files such as manifests, checksums, signatures, and certificates. [PDP-01]
*****

Notice that I removed "related to the application" as unnecessary.

Then, 4.1.1 Supported Archive Compression Formats:

*****
A Provider SHALL support the following compression formats for a PDP:
A PDP with ZIP compression [ZIP] [PDP-02]
A PDP as a TAR file [TAR] [PDP-03]
A PDP with GZIP [RFC1952] compression of a TAR file [PDP-04]
Providers MAY support additional compression formats for the PDP. [PDP-05]
*****

BTW, note my making the distinction between PDP and the format of its compression, enables "at the root of the archive" to be meaningful in the specification. Otherwise the 5 instances of "at the root of the archive" make no sense. Only file and XML structures have roots. Flat collections of files do not.

Show
Try this: ***** A PDP is a directory structure which contains a Plan file named camp.yaml at its root. A PDP May contain sub-directories and other files including, but not limited to, language-specific bundles, resource files, application content files such as web archives, database schemas, scripts, source code, localization bundles, and icons; and metadata files such as manifests, checksums, signatures, and certificates. [PDP-01] ***** Notice that I removed "related to the application" as unnecessary. Then, 4.1.1 Supported Archive Compression Formats: ***** A Provider SHALL support the following compression formats for a PDP: A PDP with ZIP compression [ZIP] [PDP-02] A PDP as a TAR file [TAR] [PDP-03] A PDP with GZIP [RFC1952] compression of a TAR file [PDP-04] Providers MAY support additional compression formats for the PDP. [PDP-05] ***** BTW, note my making the distinction between PDP and the format of its compression, enables "at the root of the archive" to be meaningful in the specification. Otherwise the 5 instances of "at the root of the archive" make no sense. Only file and XML structures have roots. Flat collections of files do not.

Description

One of the issues created by the incomplete glossary is the use of "archive" in 4.1, 4.1.1 and following.

4.1 PDP Package Structure reads:

*****
A PDP is an archive which contains a Plan file named camp.yaml at the root of the archive. A PDP archive MAY include other files related to the application including, but not limited to, language-specific bundles, resource files, application content files such as web archives, database schemas, scripts, source code, localization bundles, and icons; and metadata files such as manifests, checksums, signatures, and certificates. [PDP-01]
*****

The phrase, "... at the root of the archive" implies that an "archive" may have nested directory structures. That is the essence of having a "root." However, the following enumeration fails to mention any such directory structures.

Moreover, 4.1.1 Supported Archive Formats reads:

*****
A Provider SHALL support the following archive formats for a PDP:
A PDP as a ZIP archive [ZIP] [PDP-02]
A PDP as a TAR archive [TAR] [PDP-03]
A PDP as a GZIP [RFC1952] compressed TAR archive [PDP-04]
Providers MAY support additional archive formats for the PDP. [PDP-05]
*****

Also wrong because ZIP, TAR and GZIP are compression formats, not archive formats.

Confusing use of "archive" in 4.1, 4.1.1 and following.

Details

Description

Attachments

Activity

People

Dates