This document specifies the format a of CTF 2 document identifier.
RFC 2119
The key words MUST, MUST NOT, REQUIRED,
SHOULD, SHOULD NOT, MAY, and OPTIONAL in this document, when
emphasized, are to be interpreted as described in
RFC 2119.
|
Document identification
The name of this document (CTF2‑DOCID‑2.0) follows its own
specification.
|
1. Revision history
This document is the initial version of CTF2‑DOCID‑2.0.
Significant changes since CTF2‑DOCID‑1.0:
-
Specify that revision indicator
rAA
comes afterrZ
. -
Specify that the first major version of any document is 1
-
Specify that the first minor version of a given major version is 0.
2. Format
All the CTF 2 documents which the DiaMon Workgroup publishes MUST have a unique document identifier (ID) which has the following format:
CTF2-SHORTNAME-MAJOR.MINOR[rREV]
Part | Description | Bump may introduce new concepts, procedures, and formats? | Bump may remove or change existing concepts, procedures, and formats? |
---|---|---|---|
|
The capitalized short name of the document, unique amongst all the CTF 2 documents. |
N/A |
N/A |
|
The major version number of the document. The first major version of any document is 1. |
Yes |
Yes |
|
The minor version number of the document. The first minor version of a given major version is 0. |
Yes |
No |
The revision letter of the document (from The DiaMon Workgroup uses document revisions to add examples, clarify existing concepts, fix grammar or content mistakes, or reword existing parts, for example. |
No |
No |
Consider this CTF 2 document ID: CTF2-ANAME-1.2rC.
Its parts are:
CTF2 |
This is a CTF 2 document. |
ANAME |
Document’s short name. |
1.2 |
First major version, third minor version. |
rC |
Revision C of the document. |
3. Document reference
The text of any published CTF 2 document MUST only use the document ID of another published CTF 2 document to which it refers, without the revision part.
If a CTF 2 producer applies CTF2-ANAME-1.2, then …