Correct man page formatting in RST output

[ric-plt/lib/rmr.git] / doc / src / rtd / fmt_changes.ksh

diff --git a/doc/src/rtd/fmt_changes.ksh b/doc/src/rtd/fmt_changes.ksh
index 47c684d..930bce4 100644 (file)
--- a/doc/src/rtd/fmt_changes.ksh
+++ b/doc/src/rtd/fmt_changes.ksh
@@ -22,46 +22,49 @@
 #                              RTD file is created.
 
 cat <<endKat
+
+.** ------------------------------------------------------------------------
+.** CAUTION: This .xfm file is automatically generated by fmt_changes.ksh
+.**          do NOT edit. Use 'make rel-notes.xfm' to regenerate.
+.** ------------------------------------------------------------------------
+
+.dv GEN_TITLE 1
+.dv doc_title RMR Release Notes
 .im setup.im
-&h1(RMR Release Notes)
-The following is a list of release highlights for the core RMR library and 
-wrappers which are housed in the same repository.
-These are extracted directly from the CHANGES_*.txt files at the repo root; 
-please refer to those files for a completely up to date listing of
-API changes (as generated documents may lag).  
-&space
+.dh 1 u=off
 
-The RMR repo houses two distinct release entities: the core RMR package
-and the python wrapper package.
-To avoid naming conflicts (tags mostly) The core package uses odd 
-major version numbers (e.g. 3.2.1) and the wrapper package uses even
-major version numbers. 
-The release notes are split into two sections; please be sure to 
-scroll to the section that is appropriate.
+&h1(RMR Release Notes)
+The following is a list of release highlights for the RMR library.
+At one point in time the RMR repo also housed a wrapper library with a
+separate version and release cycle.
+This resulted in &ital(leap frogging) versions for each package; the
+RMR core library was assigned odd major numbers (e.g. 3.1.0).
+When the wrapper code was moved to a different repo the need to leap frog
+versions ceased, and beginning with version 4.0.0, the RMR versions should
+no longer skip.
 
 endKat
 
 for x in ../../../CHANGES*.txt
 do
-       case $x in 
-               *CORE*) printf "&h2(Core RMR Changes)\n" ;;
-               *)      printf "&h2(Wrapper Changes)\n" ;;
-       esac
+       awk '
+               /^#/ { next }           # ditch all comments
+
+               # tag project releases by matching release tag associated
+               /4\.0\.5$/  { printf( "&h1(Bronze Release)\n" ); rheader = 1 }
+               /1\.11\.1$/ { printf( "&h1(Amber Release)\n" ); rheader = 1 }
+
+               print_raw && /^$/ {                             # include blank lines after first real stuff
+                       printf( "&space\n\n" );
+                       next
+               }
 
-       sed 's/^/!/' $x | awk ' 
-               print_raw && /^!$/ { 
-                       printf( "&space\n\n" ); 
-                       next 
-               } 
-       
-               { gsub ( "!", "", $1 ) }
-       
                $1 + 0 >= 2019 {
-                       print_raw = 1
-                       printf( "&h3(%s)\n", $0 )
-                       next 
+                       print_raw = 1                           # safe to print blank lines
+                       printf( "&h2(%s)\n", $0 )
+                       next
                }
-       
-               print_raw { print } 
-               ' ###
+
+               print_raw { print }
+       ' $x
 done