From: Daniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Date: Mon, 21 Nov 2016 18:25:26 +0000 (+0100)
Subject: Extend READE.md
X-Git-Tag: v8.5.0-rc1~330^2~2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ab40762b107dc66220197f4ff77cd9cb42d308e3;p=dealii.git

Extend READE.md
---

diff --git a/doc/news/changes/README.md b/doc/news/changes/README.md
index bc739025d4..e89cb519fa 100644
--- a/doc/news/changes/README.md
+++ b/doc/news/changes/README.md
@@ -18,23 +18,28 @@ A typical file could look like this:
 
 and is named "YYYYMMDDJohnDoe". File names for multiple contributions from the 
 same author on one day have a number appended, e.g. "YYYMMDDJohnDoe\_1".
+Only the file name is used to have a proper order in "changes.h". This
+means that the file can in principle have an arbitrary name as long as the date
+in the file and in the file name match.
 
 incompatibilities
 -----------------
 
 The "incompatibilities" section contains modifications to the library that 
 are incompatible with previous versions of the library, but which are
-necessary for the future maintainability of the library. 
+necessary for the future maintainability of the library.
 
 major
 -----
 
 Entries in the "major" section are reserved for substantial changes to the
 library. In particular, this should be sufficiently compact. A good example
-for this category would be adding a new tutorial program.
+for this category would be adding a new tutorial program or a new
+FiniteElement class.
 
 minor
 -----
 
 Finally, the "minor" section contains all the changes that do not fit in
-the former two.
+the former two. Bug fixes and pull requests that generalize functions
+are typical examples.
diff --git a/doc/news/changes/create_changes_h.sh b/doc/news/changes/create_changes_h.sh
index 24302b43a4..a68dbfd79b 100755
--- a/doc/news/changes/create_changes_h.sh
+++ b/doc/news/changes/create_changes_h.sh
@@ -36,23 +36,14 @@ function process_directory
   echo "<ol>" >> ${OUTPUT}
   # process all entries in the right order
   ARRAY=($(ls "$1" | sort -r))
-  if ! [ -z "${ARRAY[0]}" ]; then
-    # treat the first item special
-    # we don't want to insert a new line here
+  for f in "${ARRAY[@]}"; do
+    echo "" >> ${OUTPUT}
     echo -n " <li>" >> ${OUTPUT}
     # indent lines by one blank space
-    sed 's/^[ ]*/ /' "$1"/"${ARRAY[0]}" >> ${OUTPUT}
+    sed 's/^[ ]*/ /' "$1"/"$f" >> ${OUTPUT}
     echo " </li>" >> ${OUTPUT}
-    unset "ARRAY[0]"
-
-    for f in "${ARRAY[@]}"; do
-      echo "" >> ${OUTPUT}
-      echo -n " <li>" >> ${OUTPUT}
-      # indent lines by one blank space
-      sed 's/^[ ]*/ /' "$1"/"$f" >> ${OUTPUT}
-      echo " </li>" >> ${OUTPUT}
-    done
-  fi
+  done
+  echo "" >> ${OUTPUT}
   echo "</ol>" >> ${OUTPUT}
 }