Skip to content
This repository was archived by the owner on Mar 5, 2024. It is now read-only.
This repository was archived by the owner on Mar 5, 2024. It is now read-only.

JSR358-96: Create errata process, separate from the MR process #67

Open
@apastsya

Description

@apastsya

Jira issue originally created by user shannon:

As I describe here, there are two JCP processes (JSR, MR) that we use for two different kinds of changes (new spec version, errata). Unfortunately, the processes don't match the kinds of changes we make, which leads to confusion.

Having a lightweight process for creating a new version of a spec (the MR process) is important, but it would reduce confusion if there were a separate process for correcting errors in existing specifications (errata).

In the simplest case, errata might fix typographical and formatting errors in a specification document. They are also use to fix inconsistencies in a specification, improve the description of requirements, etc. There are some key differences between an errata and an MR or JSR:

** Errata do not* create a new version of a spec. If the spec was version "Wombat 1.1" before the errata, the spec is still version "Wombat 1.1" after the errata.

  • Errata update a spec by introducing a new "rev level" of the specification document, e.g., updating "Wombat 1.1" to "Wombat 1.1 rev A". Both documents are specifications for the "Wombat 1.1" API.
  • Errata apply to existing licensees of a spec, they do not create a new spec that can be licensed, or that existing licensees can choose to upgrade to. Thus, errata can not change the licensing terms for a spec.
  • Errata do not introduce new requirements, although they may clarify existing requirements.
  • Errata do not change API signatures except to correct inconsistencies between the specification and the reference implementation, or to correct incompatibilities with previous versions of the specification.
  • Errata do not change functional requirements except to correct inconsistencies between the specification and the reference implementation, or to correct incompatibilities with previous versions of the specification.
  • In general, errata will not require changes to the reference implementation or the TCK, except to correct inconsistencies or incompatibilities as described above.

A separate errata process with limitations of this sort will make it clear what sort of change is being proposed, and will distinguish these changes from the MR process, which becomes only a lightweight form of the JSR process used to introduce new versions of a spec.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions