Correct man page formatting in RST output

Some man pages were assuming that the "&item" macro
was defined.  This change adds that macro and pushes
the affected RST man pages for RTD.

The change also adds a release header for the major
project releases to the relase notes file.

Issue-ID: RIC-510

Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: I89b784c4a18ba0ac85aaed2bdde8bda18e3d0946

diff --git a/CHANGES_CORE.txt b/CHANGES_CORE.txt
index 6bcb808..4480a81 100644 (file)
--- a/CHANGES_CORE.txt
+++ b/CHANGES_CORE.txt
@@ -173,14 +173,14 @@
        Add ability to route messages based on the MEID in a message combined
        with the message type/subscription-ID.
 
-2019 November 14; version 1.11.1 (Amber)
+2019 November 14; version 1.11.1
        Fix bug in payload reallocation function; correct length of payload
        was not always copied.
 
 2019 November 13; version 1.12.1
        New message type constants added to support A1.
 
-2019 November 4; version 1.11.0 (Amber)
+2019 November 4; version 1.11.0
        Version bump to move away from the 1.10.* to distinguish between
        release A and the trial.
 

diff --git a/doc/src/library/failures.im b/doc/src/library/failures.im
index 154cdd1..a6e2495 100644 (file)
--- a/doc/src/library/failures.im
+++ b/doc/src/library/failures.im
@@ -43,7 +43,7 @@ typically the underlying cause:
 
 &half_space
 &indent
-&beg_list( &lic1 )
+&beg_list(&lic1)
        &li The session to the targeted recipient (endpoint) is not connected.
        &half_space
 

diff --git a/doc/src/library/general_use.im b/doc/src/library/general_use.im
index 9b01d4e..9c3723a 100644 (file)
--- a/doc/src/library/general_use.im
+++ b/doc/src/library/general_use.im
@@ -80,7 +80,7 @@ either directly or indirectly:
 
 &half_space
 &indent
-&beg_list( &lic1 )
+&beg_list(&lic1)
        &li The payload (actual data)
        &half_space
        &li The total payload length in bytes

diff --git a/doc/src/library/user.xfm b/doc/src/library/user.xfm
index 3fe3e12..a704eec 100644 (file)
--- a/doc/src/library/user.xfm
+++ b/doc/src/library/user.xfm
@@ -58,7 +58,7 @@ The library provides the following major features:
 
 &half_space
 &indent
-&beg_list( &lic1 )
+&beg_list(&lic1)
        &li Routing and endpoint selection is based on &ital(message type.)
        &half_space
 

diff --git a/doc/src/rst.im b/doc/src/rst.im
index 6082da2..3510c24 100644 (file)
--- a/doc/src/rst.im
+++ b/doc/src/rst.im
@@ -110,6 +110,7 @@
        .dv beg_list .sp 1 .bl ${1!*} ^: .br
        .dv end_list .el .sp 1
        .dv li .br .li
+       .dv item .br .li
 
        .dv ex_start .sp 1 ^:^: .sp 1 .ll -2 .in +2 .nf
        .dv ex_end .fo on .in -2 .ll +2 .sp 1

diff --git a/doc/src/rtd/.gitignore b/doc/src/rtd/.gitignore
index 76089b2..24befa4 100644 (file)
--- a/doc/src/rtd/.gitignore
+++ b/doc/src/rtd/.gitignore
@@ -1,3 +1,4 @@
+rel-notes.xfm
 man_list.im
 *.html
 *.md

diff --git a/doc/src/rtd/fmt_changes.ksh b/doc/src/rtd/fmt_changes.ksh
index 095bea0..930bce4 100644 (file)
--- a/doc/src/rtd/fmt_changes.ksh
+++ b/doc/src/rtd/fmt_changes.ksh
@@ -23,6 +23,11 @@
 
 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
@@ -37,26 +42,29 @@ 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.
-&space
 
 endKat
 
 for x in ../../../CHANGES*.txt
 do
-       sed 's/^/!/' $x | awk '
-               print_raw && /^!$/ {
+       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
                }
 
-               { gsub ( "!", "", $1 ) }
-
                $1 + 0 >= 2019 {
-                       print_raw = 1
+                       print_raw = 1                           # safe to print blank lines
                        printf( "&h2(%s)\n", $0 )
                        next
                }
 
                print_raw { print }
-               ' ###
+       ' $x
 done

diff --git a/doc/src/rtd/setup.im b/doc/src/rtd/setup.im
index fb1e639..47f7a5a 100644 (file)
--- a/doc/src/rtd/setup.im
+++ b/doc/src/rtd/setup.im
@@ -60,8 +60,6 @@
        .fi
 .fi
 
-.dh u=off
-
 .** if we can set a license into the output, do it early
 .cd 1 11i
 &line_len(10i)

diff --git a/docs/rel-notes.rst b/docs/rel-notes.rst
index e14a05e..1ea3c61 100644 (file)
--- a/docs/rel-notes.rst
+++ b/docs/rel-notes.rst
@@ -20,7 +20,11 @@ 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. 
- 
+
+
+Bronze Release
+==============
+
 
 
 2020 May 06; version 4.0.5
@@ -384,8 +388,13 @@ combined with the message type/subscription-ID.
  
 
 
-2019 November 14; version 1.11.1 (Amber)
-----------------------------------------
+Amber Release
+=============
+
+
+
+2019 November 14; version 1.11.1
+--------------------------------
 
 Fix bug in payload reallocation function; correct length of 
 payload was not always copied. 
@@ -399,8 +408,8 @@ New message type constants added to support A1.
  
 
 
-2019 November 4; version 1.11.0 (Amber)
----------------------------------------
+2019 November 4; version 1.11.0
+-------------------------------
 
 Version bump to move away from the 1.10.* to distinguish 
 between release A and the trial. 

diff --git a/docs/rmr_call.3.rst b/docs/rmr_call.3.rst
index 409b92d..bb02415 100644 (file)
--- a/docs/rmr_call.3.rst
+++ b/docs/rmr_call.3.rst
@@ -81,11 +81,11 @@ The send operations in RMR will retry *soft* send failures
 until one of three conditions occurs: 
  
  
- &item The message is sent without error 
+* The message is sent without error 
   
- &item The underlying transport reports a *hard* failure 
+* The underlying transport reports a *hard* failure 
   
- &item The maximum number of retry loops has been attempted 
+* The maximum number of retry loops has been attempted 
  
  
 A retry loop consists of approximately 1000 send attempts 

diff --git a/docs/rmr_mt_call.3.rst b/docs/rmr_mt_call.3.rst
index 60d343c..f8b295b 100644 (file)
--- a/docs/rmr_mt_call.3.rst
+++ b/docs/rmr_mt_call.3.rst
@@ -88,11 +88,11 @@ The send operations in RMR will retry *soft* send failures
 until one of three conditions occurs: 
  
  
- &item The message is sent without error 
+* The message is sent without error 
   
- &item The underlying transport reports a *hard* failure 
+* The underlying transport reports a *hard* failure 
   
- &item The maximum number of retry loops has been attempted 
+* The maximum number of retry loops has been attempted 
  
  
 A retry loop consists of approximately 1000 send attempts 

diff --git a/docs/rmr_rts_msg.3.rst b/docs/rmr_rts_msg.3.rst
index af9958b..b0637cc 100644 (file)
--- a/docs/rmr_rts_msg.3.rst
+++ b/docs/rmr_rts_msg.3.rst
@@ -51,11 +51,11 @@ The send operations in RMR will retry *soft* send failures
 until one of three conditions occurs: 
  
  
- &item The message is sent without error 
+* The message is sent without error 
   
- &item The underlying transport reports a *hard* failure 
+* The underlying transport reports a *hard* failure 
   
- &item The maximum number of retry loops has been attempted 
+* The maximum number of retry loops has been attempted 
  
  
 A retry loop consists of approximately 1000 send attempts 

diff --git a/docs/rmr_send_msg.3.rst b/docs/rmr_send_msg.3.rst
index 06487be..33fd9cf 100644 (file)
--- a/docs/rmr_send_msg.3.rst
+++ b/docs/rmr_send_msg.3.rst
@@ -58,11 +58,11 @@ The send operations in RMR will retry *soft* send failures
 until one of three conditions occurs: 
  
  
- &item The message is sent without error 
+* The message is sent without error 
   
- &item The underlying transport reports a *hard* failure 
+* The underlying transport reports a *hard* failure 
   
- &item The maximum number of retry loops has been attempted 
+* The maximum number of retry loops has been attempted 
  
  
 A retry loop consists of approximately 1000 send attempts 

diff --git a/docs/rmr_wh_call.3.rst b/docs/rmr_wh_call.3.rst
index 57d28cc..9e6da4e 100644 (file)
--- a/docs/rmr_wh_call.3.rst
+++ b/docs/rmr_wh_call.3.rst
@@ -71,11 +71,11 @@ The send operations in RMR will retry *soft* send failures
 until one of three conditions occurs: 
  
  
- &item The message is sent without error 
+* The message is sent without error 
   
- &item The underlying transport reports a *hard* failure 
+* The underlying transport reports a *hard* failure 
   
- &item The maximum number of retry loops has been attempted 
+* The maximum number of retry loops has been attempted 
  
  
 A retry loop consists of approximately 1000 send attempts 

diff --git a/docs/rmr_wh_send_msg.3.rst b/docs/rmr_wh_send_msg.3.rst
index 0849ac2..7de91a8 100644 (file)
--- a/docs/rmr_wh_send_msg.3.rst
+++ b/docs/rmr_wh_send_msg.3.rst
@@ -62,11 +62,11 @@ The send operations in RMR will retry *soft* send failures
 until one of three conditions occurs: 
  
  
- &item The message is sent without error 
+* The message is sent without error 
   
- &item The underlying transport reports a *hard* failure 
+* The underlying transport reports a *hard* failure 
   
- &item The maximum number of retry loops has been attempted 
+* The maximum number of retry loops has been attempted 
  
  
 A retry loop consists of approximately 1000 send attempts