Mark all Normative Statements with RFC2119 terms and format to identify in the specification text

XMLWordPrintable

    • Type: Improvement
    • Resolution: Fixed
    • Priority: Major
    • CSD1
    • Affects Version/s: CSD1
    • Component/s: Spec
    • None
    • Hide

      1) Each statement shall use RFC2119 terms and those terms shall be put in upper case
      2) Each statement shall be given a unique identifier
      3) Each statement shall be given formatting to clearly separate it from the surrounding text

      Attached to this issue is a sample of the WD01 version spec with some of the normative statements marked up using one possible approach that satisfies these 3 items. See section 2.7.2 from line 217 to 249.

      Here each normative statement:
      a) has RFC2119 words in uppercase
      b) each statement is preceded by a unique label based on the section number and a count: e.g. [R2.7.2-4]
      c) Each normative statement starts on a new line and ends with a line break
      d) Each normative statement is picked out in a highlight colour (yellow in the sample document.

      Of course, the details are open to debate, but the principles are clear.

      Show
      1) Each statement shall use RFC2119 terms and those terms shall be put in upper case 2) Each statement shall be given a unique identifier 3) Each statement shall be given formatting to clearly separate it from the surrounding text Attached to this issue is a sample of the WD01 version spec with some of the normative statements marked up using one possible approach that satisfies these 3 items. See section 2.7.2 from line 217 to 249. Here each normative statement: a) has RFC2119 words in uppercase b) each statement is preceded by a unique label based on the section number and a count: e.g. [R2.7.2-4] c) Each normative statement starts on a new line and ends with a line break d) Each normative statement is picked out in a highlight colour (yellow in the sample document. Of course, the details are open to debate, but the principles are clear.
    • Hide

      This work was completed and can be found in CSD01.

      Show
      This work was completed and can be found in CSD01.

      All Normative statements in the TOSCA specification need to be clearly identified. In the current version of the specification this is not the case, making it difficult for an implementer to assure that their implementation conforms to the specification.

            Assignee:
            Thomas Spatzier (Inactive)
            Reporter:
            Mike Edwards (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved: