You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| 1 | Nature of the specification| A collective derivative work from the individual member contributions, together with staff contributions |
27
+
| 1 | Nature of an OpenHW Group specification | A collective derivative work from the individual member contributions, together with staff contributions |
28
28
| 2 | Editors of the specification | OpenHW via its members and staff |
29
29
| 3 | Contributions by non-members | For further study |
30
30
| 4 | Eclipse Specification Process | Not used |
@@ -33,16 +33,20 @@ OpenHW uses a lightweight specification development process to produce specifica
| 4 | Copyright Grant included in specification publication | As per publication license: |
60
+
| 5.1 | Apache 2.0 | Yes, copyright grant included with OpenHW publication |
61
+
| 5.2 | Solderpad 2.1 | Yes, copyright grant included with OpenHW publication |
62
+
| 5.3 | Commons Attribution Share Alike 4.0 International license | Yes, copyright grant included with OpenHW publication |
59
63
| 6 | Patent Grant included in specification publication | As per publication license |
60
-
| 6.1 | Apache 2.0 |Yes |
61
-
| 6.2 | Solderpad 2.1 |Yes |
62
-
| 6.3 | Commons Attribution Share Alike 4.0 International license | No |
64
+
| 6.1 | Apache 2.0 |No patent grant provided by OpenHW but patents rights granted under contribution|
65
+
| 6.2 | Solderpad 2.1 |No patent grant provided by OpenHW but patents rights granted under contribution|
66
+
| 6.3 | Commons Attribution Share Alike 4.0 International license | No patent grant included with OpenHW publication|
63
67
| 7 | Essential patents disclosed by OpenHW | No |
64
68
| 8 | License text included within the specification text | No - referall only |
65
69
| 0 | "No-warranty" or disclaimer | Required |
66
70
67
71
72
+
### Specification Version numbers
73
+
74
+
OpenHW Specifications shall use semantic versioning https://semver.org/ with the version in the form X.Y.Z.
75
+
The version number is combined with the Specification State (below), for example "1.0.0 - Released" to indicate both the version number and state.
76
+
77
+
78
+
68
79
### Specification States
69
80
70
-
The ratification or completion state ais meant to be written in each OpenHW specification so that a reader will be aware of the state of completion of the Specification
81
+
The ratification or completion state is meant to be written in each OpenHW specification so that a reader will be aware of the state of completion of the Specification
71
82
These are the OpenHW Specification States:
72
83
73
84
- “OpenHW Specification - In Development"
74
85
- "OpenHW Specification - In Review"
86
+
- "OpenHW Specification - Release Candidate"
75
87
- "OpenHW Specification - Released"
76
88
77
89
#### "OpenHW Specification - In Development"
78
90
79
91
When the specification is initiated, all drafts will be labelled as “OpenHW Specification - In Development"
92
+
(During initial development of the spec before first release, the version number is of the form X.Y.Z with X=0.)
80
93
81
-
Revision numbers should be of the form 0.Y.Z
94
+
This state is also used when a released spec is subsequently revised.
82
95
96
+
During revision of a released specifiation, the version number increments as appropriate depending on whether the revision is a major or minor update.
83
97
84
98
#### "OpenHW Specification - In Review"
85
99
86
-
When the specification is frozen for technical review, all drafts will be labelled as "OpenHW Specification - In Review"
100
+
When the specification is frozen for technical review by a Task Group, all drafts will be labelled as "OpenHW Specification - In Review"
87
101
88
-
Revision numbers should be of the form 0.Y.Z
102
+
When the TG(s) has completed its review, the reviewed and stable version will be relabelled as "Release Candidate" - see next section.
89
103
90
-
#### "OpenHW Specification - Released"
104
+
#### "OpenHW Specification - Release Candidate"
91
105
92
-
When the specification is published, the publication copy will be labelled as "OpenHW Specification - Released"
93
-
Revision numbers should be of the form X.Y.Z, starting with 1.0.0 as the initially released version.
106
+
When the specification is proposed as a candidate for release, drafts will be labelled as "OpenHW Specification - Release Candidate"
107
+
108
+
The complete descriptor of the spec at this stage will be "X.Y.Z - Release Candidate", where X.Y.Z is the proposed release number.
109
+
110
+
111
+
#### "OpenHW Specification - Released"
94
112
95
-
#### "OpenHW Specification Revision"
113
+
When a Release Candidate specification has completed ratification (through a TWG vote), the released copy will be labelled as "OpenHW Specification - Released"
114
+
Revision numbers should be of the form X.Y.Z, normally starting with X=1 as the initially released version.
96
115
97
-
Process for labelling and numbering released specifications in revision to be decided.
98
116
99
117
100
118
## Specification Format
@@ -109,7 +127,7 @@ The Title should be of the form "OpenHW Specifciation: Title"
109
127
110
128
Prior to release a table of draft revisions should be included, which can included description of content in each draft
111
129
112
-
Upon release and subsequently, the Revision History should list only released specification versions, starting with 1.0.0.
130
+
Upon release, the Revision History should list only released specification versions. That is, intermediate revisisions used during development and review don't need to be listed.
113
131
The table should include Revision, Date, and Description. The Description should include a high level description of the content.
114
132
115
133
### Specification States
@@ -143,7 +161,7 @@ The following opyright text is included:
0 commit comments