From 3e9921d5307c6090298cdebbb81a332112463caf Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Sat, 19 Nov 2016 15:25:34 +0100 Subject: [PATCH] Rename categories and provide README.md --- doc/news/changes/README.md | 40 +++++++++++++++++++ doc/news/{ => changes}/create_changes_h.sh | 18 ++++----- doc/news/{ => changes}/footer | 0 doc/news/{ => changes}/header | 0 .../{ => changes}/header_incompatibilities | 0 .../{header_general => changes/header_major} | 0 .../{header_specific => changes/header_minor} | 0 .../incompatibilities}/.dummy | 0 .../major}/.dummy | 0 doc/news/{specific => changes/minor}/.dummy | 0 .../minor}/20161118DanielArndt | 0 doc/news/{ => changes}/split_changes_h.sh | 30 ++++++++------ doc/news/{ => changes}/split_summary.sh | 0 13 files changed, 67 insertions(+), 21 deletions(-) create mode 100644 doc/news/changes/README.md rename doc/news/{ => changes}/create_changes_h.sh (84%) rename doc/news/{ => changes}/footer (100%) rename doc/news/{ => changes}/header (100%) rename doc/news/{ => changes}/header_incompatibilities (100%) rename doc/news/{header_general => changes/header_major} (100%) rename doc/news/{header_specific => changes/header_minor} (100%) rename doc/news/{general => changes/incompatibilities}/.dummy (100%) rename doc/news/{incompatibilities => changes/major}/.dummy (100%) rename doc/news/{specific => changes/minor}/.dummy (100%) rename doc/news/{specific => changes/minor}/20161118DanielArndt (100%) rename doc/news/{ => changes}/split_changes_h.sh (71%) rename doc/news/{ => changes}/split_summary.sh (100%) diff --git a/doc/news/changes/README.md b/doc/news/changes/README.md new file mode 100644 index 0000000000..bc739025d4 --- /dev/null +++ b/doc/news/changes/README.md @@ -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 "
" from the first one. +A typical file could look like this: + + New: We can do fancy stuff now. +
+ (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. diff --git a/doc/news/create_changes_h.sh b/doc/news/changes/create_changes_h.sh similarity index 84% rename from doc/news/create_changes_h.sh rename to doc/news/changes/create_changes_h.sh index c0d262183e..24302b43a4 100755 --- a/doc/news/create_changes_h.sh +++ b/doc/news/changes/create_changes_h.sh @@ -16,20 +16,20 @@ # # 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} diff --git a/doc/news/footer b/doc/news/changes/footer similarity index 100% rename from doc/news/footer rename to doc/news/changes/footer diff --git a/doc/news/header b/doc/news/changes/header similarity index 100% rename from doc/news/header rename to doc/news/changes/header diff --git a/doc/news/header_incompatibilities b/doc/news/changes/header_incompatibilities similarity index 100% rename from doc/news/header_incompatibilities rename to doc/news/changes/header_incompatibilities diff --git a/doc/news/header_general b/doc/news/changes/header_major similarity index 100% rename from doc/news/header_general rename to doc/news/changes/header_major diff --git a/doc/news/header_specific b/doc/news/changes/header_minor similarity index 100% rename from doc/news/header_specific rename to doc/news/changes/header_minor diff --git a/doc/news/general/.dummy b/doc/news/changes/incompatibilities/.dummy similarity index 100% rename from doc/news/general/.dummy rename to doc/news/changes/incompatibilities/.dummy diff --git a/doc/news/incompatibilities/.dummy b/doc/news/changes/major/.dummy similarity index 100% rename from doc/news/incompatibilities/.dummy rename to doc/news/changes/major/.dummy diff --git a/doc/news/specific/.dummy b/doc/news/changes/minor/.dummy similarity index 100% rename from doc/news/specific/.dummy rename to doc/news/changes/minor/.dummy diff --git a/doc/news/specific/20161118DanielArndt b/doc/news/changes/minor/20161118DanielArndt similarity index 100% rename from doc/news/specific/20161118DanielArndt rename to doc/news/changes/minor/20161118DanielArndt diff --git a/doc/news/split_changes_h.sh b/doc/news/changes/split_changes_h.sh similarity index 71% rename from doc/news/split_changes_h.sh rename to doc/news/changes/split_changes_h.sh index f151f3df60..4e455a30cc 100755 --- a/doc/news/split_changes_h.sh +++ b/doc/news/changes/split_changes_h.sh @@ -15,22 +15,28 @@ ## --------------------------------------------------------------------- # -# 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>$/' '{*}' +csplit --silent ../changes.h '/^
      \|<\/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 '/^