[PATCH 09/13] lib/readline/doc/history.3: Revise inline struct.

[G. Branden Robinson]

This unfilled block of text was oversetting the line on DWB nroff, which
uses a line length of 65n (just like Seventh Edition Unix nroff).

Recast comments to occupy less space.

Also bracket this inline code display with `EX`/`EE` macros; this sets
the code in a monospace/constant-width font on platforms supporting this
Ninth Edition Unix/groff man(7) extension, and does nothing elsewhere.
---
 lib/readline/doc/history.3 | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/lib/readline/doc/history.3 b/lib/readline/doc/history.3
index 7b6ab73b..d36c454d 100644
--- a/lib/readline/doc/history.3
+++ b/lib/readline/doc/history.3
@@ -372,16 +372,18 @@ .SS History Storage
 The state of the History library is encapsulated into a single structure:
 .PP
 .nf
+.EX
 /*
- * A structure used to pass around the current state of the history.
+ * structure for passing around the state of history
  */
 typedef struct _hist_state {
-  HIST_ENTRY **entries; /* Pointer to the entries themselves. */
-  int offset;           /* The location pointer within this array. */
-  int length;           /* Number of elements within this array. */
-  int size;             /* Number of slots allocated to this array. */
+  HIST_ENTRY **entries; /* pointer to entry records */
+  int offset;           /* current record */
+  int length;           /* number of records in list */
+  int size;             /* capacity of list in records */
   int flags;
 } HISTORY_STATE;
+.EE
 .fi
 .PP
 If the flags member includes \fBHS_STIFLED\fP, the history has been
-- 
2.30.2

signature.asc
Description: PGP signature