jsr348
  1. jsr348
  2. JSR348-6

The TCK documentation must contain Compatibility Requirements

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Component/s: None
    • Labels:
      None

      Description

      Section 3.1 states that the TCK documentation must contain Compatibility Requirements.

      We should specify some specific requirements in the Process Doc and then provide some more detailed examples in the (non-normative) Spec Lead Guide.

        Activity

        Hide
        Bill Shannon added a comment -

        Add another bullet to the bullet list in section 3.1.:

        • Includes requirements that all compatible implementations (a) fully implement the
          Spec(s) including all required interfaces and functionality, and (b) do not modify,
          subset, superset, or otherwise extend the Licensor Name Space, or include any public or
          protected packages, classes, Java interfaces, fields or methods within the Licensor
          Name Space other than those required/authorized by the Spec or Specs being implemented.
          These requirements must apply unless the Spec or TCK explicitly allows exceptions.

        This echoes the requirements from the JSPA.

        Show
        Bill Shannon added a comment - Add another bullet to the bullet list in section 3.1.: Includes requirements that all compatible implementations (a) fully implement the Spec(s) including all required interfaces and functionality, and (b) do not modify, subset, superset, or otherwise extend the Licensor Name Space, or include any public or protected packages, classes, Java interfaces, fields or methods within the Licensor Name Space other than those required/authorized by the Spec or Specs being implemented. These requirements must apply unless the Spec or TCK explicitly allows exceptions. This echoes the requirements from the JSPA.
        Hide
        pcurran added a comment -

        NOTE: in the August 10 draft the relevant section is 4.1, beginning on line 506.

        Looks good, except that it should say "Include requirements" rather than "Includes requirements"

        Show
        pcurran added a comment - NOTE: in the August 10 draft the relevant section is 4.1, beginning on line 506. Looks good, except that it should say "Include requirements" rather than "Includes requirements"
        Hide
        Bill Shannon added a comment -

        Back to Eduardo for incorporation into the document.

        Show
        Bill Shannon added a comment - Back to Eduardo for incorporation into the document.
        Hide
        eduardo added a comment -

        Suggested edits have been incorporated. Waiting for review before closing

        Show
        eduardo added a comment - Suggested edits have been incorporated. Waiting for review before closing
        Hide
        pcurran added a comment -

        The reference to compatibility requirements in the first bullet and also in the second is a bit awkward. I suggest the following change, which isn't perfect, but I think a little better:

        Starting on line 507 of the PR draft, change:

        The TCK submitted as part of the Final Draft must meet the following requirements:

        • Include documentation covering configuration and execution of the TCK, a definition and explanation of the First-level TCK Appeals Process, the compatibility requirements that must be met in addition to passing the TCK tests, and any other information needed to use the TCK (e.g. Tools documentation).
        • Include requirements that all compatible implementations...

        to:

        The TCK submitted as part of the Final Draft must meet the following requirements:

        • Include documentation covering configuration and execution of the TCK, any other information needed to use the TCK (e.g. Tools documentation,) a definition and explanation of the First-level TCK Appeals Process, and the compatibility requirements that must be met in addition to passing the TCK tests,
        • The compatibility requirements at a minimum must specify that all compatible implementations...
        Show
        pcurran added a comment - The reference to compatibility requirements in the first bullet and also in the second is a bit awkward. I suggest the following change, which isn't perfect, but I think a little better: Starting on line 507 of the PR draft, change: The TCK submitted as part of the Final Draft must meet the following requirements: Include documentation covering configuration and execution of the TCK, a definition and explanation of the First-level TCK Appeals Process, the compatibility requirements that must be met in addition to passing the TCK tests, and any other information needed to use the TCK (e.g. Tools documentation). Include requirements that all compatible implementations... to: The TCK submitted as part of the Final Draft must meet the following requirements: Include documentation covering configuration and execution of the TCK, any other information needed to use the TCK (e.g. Tools documentation,) a definition and explanation of the First-level TCK Appeals Process, and the compatibility requirements that must be met in addition to passing the TCK tests, The compatibility requirements at a minimum must specify that all compatible implementations...
        Hide
        eduardo added a comment -

        I have implemented all suggested changes

        Show
        eduardo added a comment - I have implemented all suggested changes

          People

          • Assignee:
            eduardo
            Reporter:
            pcurran
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: