]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Rename categories and provide README.md
authorDaniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Sat, 19 Nov 2016 14:25:34 +0000 (15:25 +0100)
committerDaniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Sat, 19 Nov 2016 14:25:34 +0000 (15:25 +0100)
13 files changed:
doc/news/changes/README.md [new file with mode: 0644]
doc/news/changes/create_changes_h.sh [moved from doc/news/create_changes_h.sh with 84% similarity]
doc/news/changes/footer [moved from doc/news/footer with 100% similarity]
doc/news/changes/header [moved from doc/news/header with 100% similarity]
doc/news/changes/header_incompatibilities [moved from doc/news/header_incompatibilities with 100% similarity]
doc/news/changes/header_major [moved from doc/news/header_general with 100% similarity]
doc/news/changes/header_minor [moved from doc/news/header_specific with 100% similarity]
doc/news/changes/incompatibilities/.dummy [moved from doc/news/general/.dummy with 100% similarity]
doc/news/changes/major/.dummy [moved from doc/news/incompatibilities/.dummy with 100% similarity]
doc/news/changes/minor/.dummy [moved from doc/news/specific/.dummy with 100% similarity]
doc/news/changes/minor/20161118DanielArndt [moved from doc/news/specific/20161118DanielArndt with 100% similarity]
doc/news/changes/split_changes_h.sh [moved from doc/news/split_changes_h.sh with 71% similarity]
doc/news/changes/split_summary.sh [moved from doc/news/split_summary.sh with 100% similarity]

diff --git a/doc/news/changes/README.md b/doc/news/changes/README.md
new file mode 100644 (file)
index 0000000..bc73902
--- /dev/null
@@ -0,0 +1,40 @@
+This folder contains changelog entries
+======================================
+
+Changes between different releases in deal.II are documented in the file 
+"changes.h" that is automatically created from the files in the directories
+
+  * "major", 
+  * "minor" and 
+  * "incompatibilities".
+
+Each of these files contain a short description of a change, the authors' names
+and the date where the latter two a separated by "<br>" from the first one. 
+A typical file could look like this:
+
+    New: We can do fancy stuff now.
+    <br>
+    (John Doe, YYYY/MM/DD)
+
+and is named "YYYYMMDDJohnDoe". File names for multiple contributions from the 
+same author on one day have a number appended, e.g. "YYYMMDDJohnDoe\_1".
+
+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. 
+
+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.
+
+minor
+-----
+
+Finally, the "minor" section contains all the changes that do not fit in
+the former two.
similarity index 84%
rename from doc/news/create_changes_h.sh
rename to doc/news/changes/create_changes_h.sh
index c0d262183e95198827c30f05545de5bfe67b5846..24302b43a4e3ea8bda195950e2c1935f41b25e5b 100755 (executable)
 
 #
 # This script creates "changes.h.new" from the contributions in the subfolders
-# of ./doc/news.
+# of ./doc/news/changes.
 #
 # The script needs to be executed as 
 #   ./create_changes_h.sh
-# from ./doc_news.
+# from ./doc/news/changes.
 
 
 
-if test ! -d incompatibilities -o ! -d general -o ! -d specific ; then
-  echo "*** This script must be run from ./doc/news!"
+if test ! -d incompatibilities -o ! -d major -o ! -d minor ; then
+  echo "*** This script must be run from ./doc/news/changes!"
   exit 1
 fi
 
-OUTPUT="changes.h.new"
+OUTPUT="../changes.h.new"
 
 function process_directory
 {
@@ -63,11 +63,11 @@ cat header_incompatibilities >> ${OUTPUT}
 process_directory incompatibilities
 
 echo GENERAL
-cat header_general >> ${OUTPUT}
-process_directory general
+cat header_major >> ${OUTPUT}
+process_directory major
 
 echo SPECIFIC
-cat header_specific >> ${OUTPUT}
-process_directory specific
+cat header_minor >> ${OUTPUT}
+process_directory minor
 
 cat footer >> ${OUTPUT}
similarity index 100%
rename from doc/news/footer
rename to doc/news/changes/footer
similarity index 100%
rename from doc/news/header
rename to doc/news/changes/header
similarity index 71%
rename from doc/news/split_changes_h.sh
rename to doc/news/changes/split_changes_h.sh
index f151f3df603fb209dafdeac37b6acd6e0b992396..4e455a30ccd24c9048b7da9ecd38398d9d8816ac 100755 (executable)
 ## ---------------------------------------------------------------------
 
 #
-# This script splits the previously used into contributions in the folders:
-# incompatibilities/ general/ specific/
+# This script splits the previously used "changes.h" into contributions
+# in the folders "incompatibilities", "major" and "minor".
 # The resulting files can be used in ./create_changes_h.sh to create
 # changes.h anew.
 #
 # The script needs to be executed as 
 #   ./split_changes_h.sh
-# from ./doc_news.
+# from ./doc/news/changes.
 
-if test ! -d incompatibilities -o ! -d specific -o ! -d general ; then
-  echo "*** This script must be run from ./doc/news!"
+if test ! -d incompatibilities -o ! -d minor -o ! -d major ; then
+  echo "*** This script must be run from ./doc/news/changes!"
   exit 1
 fi
 
+if test ! -f ../changes.h ; then
+  echo "*** The file '../changes.h' does not exist!"
+  exit 1
+fi
+
+
 
-csplit --silent changes.h '/^<ol>\|<\/ol>$/' '{*}'
+csplit --silent ../changes.h '/^<ol>\|<\/ol>$/' '{*}'
 
 for f in xx*; do
   #remove HTML list tags
@@ -39,10 +45,10 @@ done
 
 mv xx00 header_incompatibilities
 mv xx01 incompatibilities/summary
-mv xx02 header_general
-mv xx03 general/summary
-mv xx04 header_specific
-mv xx05 specific/summary
+mv xx02 header_major
+mv xx03 major/summary
+mv xx04 header_minor
+mv xx05 minor/summary
 mv xx06 footer
 
 csplit --silent header_incompatibilities '/^<!--.*$/' '{*}'
@@ -56,13 +62,13 @@ csplit --silent summary '/^<li>\|<\/li>$/' '{*}'
 cd ..
 
 echo GENERAL
-cd general || exit
+cd major || exit
 csplit --silent summary '/^<li>\|<\/li>$/' '{*}'
 ../split_summary.sh
 cd ..
 
 echo SPECIFIC
-cd specific || exit
+cd minor || exit
 csplit --silent summary '/^<li>\|<\/li>$/' '{*}'
 ../split_summary.sh
 cd ..

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.