Reference documentation for deal.II version 8.5.1
doc/news/changes/README.md
1 This folder contains changelog entries
2 ======================================
3 
4 Changes between different releases in deal.II are documented in the file
5 "changes.h" that is automatically created from the files in the directories
6 
7  * "major",
8  * "minor" and
9  * "incompatibilities".
10 
11 Each of these files contain a short description of a change, the authors' names
12 and the date where the latter two a separated by "<br>" from the first one.
13 A typical file could look like this:
14 
15  New: We can do fancy stuff now.
16  <br>
17  (John Doe, YYYY/MM/DD)
18 
19 and is named "YYYYMMDDJohnDoe". File names for multiple contributions from the
20 same author on one day have a number appended, e.g. "YYYMMDDJohnDoe\_1".
21 Only the file name is used to have a proper order in "changes.h". This
22 means that the file can in principle have an arbitrary name as long as the date
23 in the file and in the file name match.
24 
25 incompatibilities
26 -----------------
27 
28 The "incompatibilities" section contains modifications to the library that
29 are incompatible with previous versions of the library, but which are
30 necessary for the future maintainability of the library.
31 
32 major
33 -----
34 
35 Entries in the "major" section are reserved for substantial changes to the
36 library. In particular, this should be sufficiently compact. A good example
37 for this category would be adding a new tutorial program or a new
38 FiniteElement class.
39 
40 minor
41 -----
42 
43 Finally, the "minor" section contains all the changes that do not fit in
44 the former two. Bug fixes and pull requests that generalize functions
45 are typical examples.