* CTF2-DOCID-1.0: CTF 2 document identifier format
@ 2016-10-25 18:27 Philippe Proulx
0 siblings, 0 replies; only message in thread
From: Philippe Proulx @ 2016-10-25 18:27 UTC (permalink / raw)
To: diamon-discuss
Cc: lttng-dev, tracecompass-dev, etienne bergeron, francois doray
HTML version:
http://diamon.org/ctf/files/CTF2-DOCID-1.0.html
Philippe Proulx
EfficiOS Inc.
http://www.efficios.com/
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
= CTF2-DOCID-1.0: CTF{nbsp}2 document identifier format
Philippe Proulx <pproulx@efficios.com>
v1.0, 21 October 2016
:toc:
:toclevels: 5
:docid: did:CTF2-DOCID-1.0
.RFC 2119
NOTE: The key words _must_, _must not_, _required_, _shall_, _shall
not_, _should_, _should not_, _recommended_, _may_, and _optional_ in
this document, when emphasized, are to be interpreted as described in
https://www.ietf.org/rfc/rfc2119.txt[RFC 2119].
== Format
All published documents related to CTF{nbsp}2 must have a unique
**document identifier** (ID) which have the following format:
CTF2-<short name>-<major>.<minor>[r<revision>]
[options="header"]
.Descriptions and roles of CTF{nbsp}2 document ID parts
|===
|Part |Description |Bump _may_ introduce new concepts, procedures, and formats? |Bump _may_ remove or change existing concepts, procedures, and formats?
|+<short{nbsp}name>+
|The capitalized **short name** of the document,
unique amongst all the published CTF{nbsp}2 documents (letters
only).
|N/A
|N/A
|`<major>`
|The **major version number** of the document.
|Yes
|Yes
|`<minor>`
|The **minor version number** of the document.
|Yes
|No
|[[rev]]`<revision>`
|
The **revision letter** of the document (from `A` to `Z`).
Document revisions are used to add examples, clarify existing concepts,
fix grammar or content mistakes, or reword existing parts, for example.
|No
|No
|===
.CTF{nbsp}2 document ID
====
Consider this CTF{nbsp}2 document ID:
CTF2-ANAME-1.2rC
Its parts are:
* **`CTF2`**: This is a CTF{nbsp}2 document.
* **`ANAME`**: Document's short name.
* **`1.2`**: First major version, third minor version.
* **`rC`**: Revision C of the document.
====
== References
The text of any published CTF{nbsp}2 document _must_ only use the
document ID of another published CTF{nbsp}2 document to which it refers,
_without_ the <<rev,revision letter>>.
.CTF{nbsp}2 document reference
====
[quote]
If a CTF{nbsp}2 producer applies CTF2-ANAME-1.2, ...
====
_______________________________________________
lttng-dev mailing list
lttng-dev@lists.lttng.org
https://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2016-10-25 18:27 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-10-25 18:27 CTF2-DOCID-1.0: CTF 2 document identifier format Philippe Proulx
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.