KhronosGroup / KSCAF_DocRequirements

Khronos Safety Critical Advisory Forum’s minimum requirements for developing a safety critical technology specification.
3 stars 1 forks source link

Implementation details: no unnecessary or confusing assumptions allowed #25

Open bnaodovic opened 6 years ago

bnaodovic commented 6 years ago

API specification should be checked that it does not make unnecessary or confusing assumptions about implementations. For example, the very last sentence of EGL section “Releasing Thread State,” which is section 3.12 in EGL version 1.5 specification, indicates that calling ‘eglGetError’ immediately following a successful call to ‘eglReleaseThread’ “will also result in reallocating per-thread state.” In this case, it is not certain whether verb “will” stands for “should” or whether it indicates an assumption about implementations.

For reference, general issue "Implementation details" is defined as issue no. 32 in the "KSCAF_DocGuidelines" project.