stevedlawrence commented on code in PR #918:
URL: https://github.com/apache/daffodil/pull/918#discussion_r1081798054
##########
daffodil-propgen/src/main/resources/org/apache/daffodil/xsd/dafext.xsd:
##########
@@ -101,6 +101,17 @@
<xs:element name="tunables">
<xs:complexType>
<xs:all>
+ <xs:element name="allowBigIntegerBits" type="xs:boolean"
default="true" minOccurs="0">
+ <xs:annotation>
+ <xs:documentation>
+ Daffodil allows the use of lengthUnits="bits" when the type is
xs:integer and
+ xs:nonNegativeInteger even though this is prohibited by the
specification. When
+ this tunable is true, a deprecation warning is emitted when this
condition is
+ encountered. When this tunable is false, this condition will
instead result in a
+ schema definition error.
Review Comment:
Speaking of which, we need a place to keep track of deprecation descriptions
so that we remember to actually put them in the release notes.
One approach is if a commit causes deprecation/compatibility issues then
there must be a clearly labeled section at the end of the commit message about
what was deprecated with a specific keyword. For example, such a commit message
might look like:
```
Make some non-backwards compatible/deprecation change
Description of what this commit does and why. This is more focused
on the actual implementation details of the change, like a normal
commit message.
Deprecation/Compatibility:
Message that can be copy/pasted into the release notes in the
deprecation/compatibility section. This is focused on what was
deprecated or causes backwards compatibility issues and the
migration details for users to resolve those issues.
DAFFODIL-XYZ
```
This way when the release manager is generating the release notes they can
just look at the git log for commits with the "Deprecation/Compatibility"
keyword and copy the message without really having to think too much.
Alternatively we could add something like that to a comment in the ticket,
but it I find searching with JIRA can be a little hard.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
