If you are having a problem with Daffodil, and think that perhaps you have found a bug, then we suggest you:
- check JIRA (to see if the bug is already reported)
- create a TDML file for reproducing the bug/issue
- create a JIRA ticket and attach your TDML
OR - email the issue to daffodil-users@oss.tresys.com
A TDML file is often useful just to ask a question about how something in DFDL works, for example, to get a clarification.
Check JIRA
First you should give a search of our JIRA tickets to see if the problem is already recorded.
...
this page has moved to https://
...
Here's a list of all tickets about bugs, new features, and improvements. In reverse chronological order (most recent first). You may want to change the issue type, or status specifications to narrow down the list, but most commonly you would just put some search keywords into the search box.
Don't go crazy with this searching however, because if you can't find it with reasonable effort (a few good guesses at search terms), then whatever is there isn't tagged sufficiently anyway.
If you do find a bug or a closely related issue that is open status, then you can add your information to it as a comment if you prefer, rather than creating a new issue. Just knowing that another person has run into the issue is helpful at assigning fix priorites.
Create a TDML File that Illustrates the Issue
The absolutely best way to report a bug is by creating a TDML test file that demonstrates the problem.
TDML stands for "Test Data Markup Language". It is a way of specifying a DFDL schema, the test data, the expected result or expected error/diagnostic messages, and it is all in a single self-contained XML file.
By convention, a TDML file uses file extension ".tdml".
Below is an annotated TDML file:
...