With each release documentation must be shipped so the user knows what has changed and what the consequences are. With prereleases the unfinished release documentation of the corresponding release will be shipped.
The release documentation consists of release notes and a change log. They are both stored in the user
documentation directory. The documents are called release-notes.html and change-log.html
respectively.
The release notes document contains:
The information above has to be written for each release specifically. Information from previous releases is not kept.
The change log contains a detailed list of changes. If an issue was created for a change the issue ID is included.
The complete change history leading up to this release is kept, so the origin of the code can be traced easily. New releases are inserted before older releases in the document, resulting in reverse chronological order.