employer
/
lvspec
1
0
Fork 0
Code Releases Activity

Added Nicole signoff on spec terms

master
Mike Gerwitz 2013-09-11 08:54:19 -04:00
parent ab2a76c3eb
commit 5df58dad94
2 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
dfn/spec.tex
View File

@ -5,6 +5,7 @@
\begindeptgroup{pm} \begindeptgroup{pm}
\label{s:specdfn} \label{s:specdfn}
\sigauth{NL}
Portions of this section conform to \rfc{2119}: ``Key words for use in RFCs to Portions of this section conform to \rfc{2119}: ``Key words for use in RFCs to
Indicate Requirement Levels''. Certain terms from the RFC have been expressly Indicate Requirement Levels''. Certain terms from the RFC have been expressly
avoided; for example, the terms ``should'' and ``should not'' are not used avoided; for example, the terms ``should'' and ``should not'' are not used
@ -12,20 +13,25 @@ because this specification's audience has the capability to alter the
specification to resolve implementation issues and should exercise that ability. specification to resolve implementation issues and should exercise that ability.
\begin{description} \begin{description}
\sigauth{NL}
\dt{conforming implementation} \dt{conforming implementation}
An implementation that meets all of the requirements of this specification. An implementation that meets all of the requirements of this specification.
\sigauth{NL}
\dt{Deprecated} \dt{Deprecated}
When used within context of this specification: the feature or requirement When used within context of this specification: the feature or requirement
will be removed in future revisions of this specification. will be removed in future revisions of this specification.
\sigauth{NL}
\dt{Exempt} \dt{Exempt}
Denotes a condition under which an implementation need not conform to a Denotes a condition under which an implementation need not conform to a
requirement. requirement.
\sigauth{NL}
\dt{implementation} \dt{implementation}
Software that implements this specification. Software that implements this specification.
\sigauth{NL}
\dt{May; Optional} \dt{May; Optional}
Alternatively, the adverb ``optionally''; denotes a requirement whose Alternatively, the adverb ``optionally''; denotes a requirement whose
implementation is not required and may be omitted; such \shall be used only to implementation is not required and may be omitted; such \shall be used only to
@ -33,51 +39,63 @@ specification to resolve implementation issues and should exercise that ability.
denote requirements that are not essential to the operation of the denote requirements that are not essential to the operation of the
implementation. implementation.
\sigauth{NL}
\dt{Removed} \dt{Removed}
A feature or requirement mentioned in an earlier revision of this A feature or requirement mentioned in an earlier revision of this
specification has been removed and will not be superseded. specification has been removed and will not be superseded.
\sigauth{NL}
\dt{section} \dt{section}
The section containing the mention of this term, as well as any subsections The section containing the mention of this term, as well as any subsections
contained within it. contained within it.
\sigauth{NL}
\dt{Shall; Must} \dt{Shall; Must}
Denotes a mandatory requirement. If an implementation does not implement such Denotes a mandatory requirement. If an implementation does not implement such
a requirement, then the implementation is not conforming and the results under a requirement, then the implementation is not conforming and the results under
such a requirement are \undefined. such a requirement are \undefined.
\sigauth{NL}
\dt{Shall Not; Must Not} \dt{Shall Not; Must Not}
Denotes an absolute prohibition. If an implementation does not honor such a Denotes an absolute prohibition. If an implementation does not honor such a
prohibition, then the implementation is not conforming and the results under prohibition, then the implementation is not conforming and the results under
such a requirement are \undefined. such a requirement are \undefined.
\sigauth{NL}
\dt{Superseded} \dt{Superseded}
The feature or requirement mentioned in an earlier revision of this The feature or requirement mentioned in an earlier revision of this
specification has been removed and replaced by another. specification has been removed and replaced by another.
\sigauth{NL}
\dt{Undefined} \dt{Undefined}
The error condition results in behavior that is not defined by a particular The error condition results in behavior that is not defined by a particular
standard; this term \shall be used only to document other standards or standard; this term \shall be used only to document other standards or
specifications---it \shall not be used to introduce undefined behavior into specifications---it \shall not be used to introduce undefined behavior into
this specification. this specification.
\sigauth{NL}
\dt{Unspecified} \dt{Unspecified}
The behavior is not determined by this specification or is inconsequential to The behavior is not determined by this specification or is inconsequential to
the implementation's operation. the implementation's operation.
\sigauth{NL}
\dt{\S} \dt{\S}
Section reference Section reference
\sigauth{NL}
\dt{\P} \dt{\P}
Paragraph reference Paragraph reference
\sigauth{NL}
\dt{$\leftarrow$} \dt{$\leftarrow$}
Store value into variable; as opposed to `$=$', which denotes a declarative Store value into variable; as opposed to `$=$', which denotes a declarative
(and consequently immutable) assignment. (and consequently immutable) assignment.
\sigauth{NL}
\dt{$\square$} \dt{$\square$}
End of example or proof. End of example or proof.
\sigauth{NL}
\dt{$\blacksquare$} \dt{$\blacksquare$}
End of formal definition. End of formal definition.
\end{description} \end{description}

1
lvspec.cls
View File

@ -681,6 +681,7 @@
The definitions in this section \shall supersede any other uses of these terms, The definitions in this section \shall supersede any other uses of these terms,
regardless of their common use in the insurance industry or elsewhere. regardless of their common use in the insurance industry or elsewhere.
\sigauth{NL}
Multiple terms that share the same definition will be delimited with semicolons. Multiple terms that share the same definition will be delimited with semicolons.
\subsection{Specification Terminology} \subsection{Specification Terminology}