1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
# Glossary of OpenSSL terms
This is a _glossary of terms_, it does not include any _formal definitions_ of
the included terms. It does, however, link to the _formal definition_ where
appropriate. In the event in a conflict between this glossary and the
_formal definition_, the _formal definition_ is **always** canonical.
## ABI
_Application binary interface_
An ABI compatible release allows a shared library to be replaced with a
new version or for applications to be relinked against the new library
with the expectation that everything will run.
ABI compatible releases are also [API](#api) compatible.
## Alpha release
An [alpha release] is an early pre-release version.
Refer to the [versioning policy] for specific details.
## API
_Application programming interface_
An API compatible release, that is not [ABI](#abi) compatible, allows
application to be recompiled against the new library with the expectation
that everything will run.
Refer to the [API compatibility policy] for specific details.
## Beta release
A [beta release] is a late pre-release version.
Refer to the [versioning policy] for specific details.
## Bug fix
A bug fix is a fix of functionality of the libraries, modules, applications
or the build system.
Refer to the [stable release updates policy] for specific details.
## Bylaws
The [OpenSSL Bylaws] provide the rules under which the OpenSSL project operates.
This includes the [Committer](#committer), [OMC](#omc) and [OTC](#otc) project
roles and how decisions are made.
## CCLA
_Corporate Contributor Licence Agreement_
The [CCLA] is a legal document that grants certain rights to code
contributed as part of the employment of the contributor. All non-trivial
contributions on behalf of an employer must be submitted under a CCLA.
Also see: [ICLA](#icla)
## CHANGES
Significant modifications for the OpenSSL library or commands are
documented in the [CHANGES.md] file.
## CI
_Continuous Integration_
A suite of tests and checks that are run on every pull request, commit or on a daily basis.
## CLA
_Contributor Licence Agreement_
This is a legal document that grants certain rights to your contributed
code. All non-trivial contributions must be submitted under a CLA,
either an ICLA for personal contributions or both an ICLA and a CCLA
for work related contributions.
Also see: [Contributor Agreements], [ICLA](#icla), [CCLA](#ccla)
## Committer
OpenSSL [committers] are contributors who have commit access to the OpenSSL
source code repository.
## End-user documentation
End-user documentation is documentation intended for users of the OpenSSL
libraries and commandline utilities.
## Functional behaviour
What the system does, rather than how it does it.
Refer to the [testing policy] for specific details.
## ICLA
_Individual Contributor Licence Agreement_
The [ICLA] is a legal document that grants certain rights to your
contributed code. All non-trivial contributions must be submitted under
an ICLA.
Also see: [CCLA](#ccla)
## LDP
_Linux Documentation Project_
Our documentation aims to broadly conform with [The Linux Documentation
Project]'s guidelines.
Refer to the [documentation policy] for specific details.
## LTS
_[Long term support]_
These releases are supported for longer than normal releases.
Refer to the [versioning policy] for specific details.
## Major release
A [major release] is one where API and ABI breaking changes are permitted.
Refer to the [versioning policy] for specific details.
## Minor release
A [minor release] is one where API and ABI breaking changes are **not** permitted
and additional functionality can be added.
Refer to the [versioning policy] for specific details.
## NEWS
Very significant modifications for the OpenSSL library or commands are
documented in the [NEWS.md] file.
## OMC
_OpenSSL Management Committee_
This group oversees all managerial and administrative aspects of the project.
The OMC is the final authority for the OpenSSL project.
The OMC is governed by the [OpenSSL Bylaws] and the various policy documents.
## OTC
_OpenSSL Technical Committee_
This group oversees all technical aspects of the project.
The OTC is governed by the [OpenSSL Bylaws] and the various policy documents.
## Patch release
A [patch release] is one where API and ABI breaking changes are **not** permitted
and no additional functionality can be added.
Refer to the [versioning policy] for specific details.
## perlasm
Assembly code wrapper written in Perl. This is done to ease compatibility
problems across assemblers, platforms and processor revisions.
For further details see the [perlasm README].
## Public interface
A public interface is any function, global variable, structure or macro
declared in a public header file.
Refer to the [API compatibility policy] for specific details.
## Stable release
A stable release is one where the permitted changes are minimised.
Refer to the [stable release updates policy] for specific details.
[alpha release]: https://github.com/openssl/general-policies/blob/master/policies/versioning-policy.md#alpha-release
[beta release]: https://github.com/openssl/general-policies/blob/master/policies/versioning-policy.md#beta-release
[committers]: https://github.com/openssl/general-policies/blob/master/policies/committer-policy.md
[Long term support]: https://github.com/openssl/general-policies/blob/master/policies/versioning-policy.md#long-term-stable-release
[major release]: https://github.com/openssl/general-policies/blob/master/policies/versioning-policy.md#major-release
[minor release]: https://github.com/openssl/general-policies/blob/master/policies/versioning-policy.md#minor-release
[patch release]: https://github.com/openssl/general-policies/blob/master/policies/versioning-policy.md#patch-release
[versioning policy]: https://github.com/openssl/general-policies/blob/master/policies/versioning-policy.md
[stable release updates policy]: https://github.com/openssl/technical-policies/blob/master/policies/stable-release-updates.md
[testing policy]: https://github.com/openssl/technical-policies/blob/master/policies/testing.md
[documentation policy]: https://github.com/openssl/technical-policies/blob/master/policies/documentation-policy.md#language
[API compatibility policy]: https://github.com/openssl/technical-policies/blob/master/policies/api-compat.md
[perlasm README]: https://github.com/openssl/openssl/blob/master/crypto/perlasm/README.md
[ICLA]: https://www.openssl.org/policies/openssl_icla.pdf
[CCLA]: https://www.openssl.org/policies/openssl_ccla.pdf
[Contributor Agreements]: https://www.openssl.org/policies/cla.html
[OpenSSL Bylaws]: https://www.openssl.org/policies/omc-bylaws.html
[CHANGES.md]: https://github.com/openssl/openssl/blob/master/CHANGES.md
[NEWS.md]: https://github.com/openssl/openssl/blob/master/NEWS.md
[OpenSSL Bylaws]: https://www.openssl.org/policies/omc-bylaws.html
[The Linux Documentation Project]: https://tldp.org/
|
