bug-bash
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 03/13] lib/readline/doc/history.3: Drop spacing around (sub)secti


From: G. Branden Robinson
Subject: [PATCH 03/13] lib/readline/doc/history.3: Drop spacing around (sub)section headings.
Date: Thu, 28 Mar 2024 16:11:19 -0500

When formatting for typesetters, a blank input line produces 1 vee (one
line height, basically) of vertical space, but the default
inter-paragraph distance in man(7) is 0.4v.  Second, the package always
puts inter-paragraph spacing before a (sub)section heading anyway.
Third, forcing vertical space after a (sub)section heading is
nonidiomatic.

Fixes numerous style warnings from "nroff -rCHECKSTYLE=3 -man" in groff
1.23.0 of the following form.

an.tmac:lib/readline/doc/history.3:xxx: style: blank line in input
---
 lib/readline/doc/history.3 | 13 -------------
 1 file changed, 13 deletions(-)

diff --git a/lib/readline/doc/history.3 b/lib/readline/doc/history.3
index 4f1af5fe..266d91f6 100644
--- a/lib/readline/doc/history.3
+++ b/lib/readline/doc/history.3
@@ -67,7 +67,6 @@ .SH DESCRIPTION
 History library is able to keep track of those lines, associate arbitrary
 data with each line, and utilize information from previous lines in
 composing new ones.
-.PP
 .SH "HISTORY EXPANSION"
 The history library supports a history expansion feature that
 is identical to the history expansion in
@@ -404,7 +403,6 @@ .SS Initializing History and State Management
 
 .F1 void history_set_history_state "HISTORY_STATE *state"
 Set the state of the history list according to \fIstate\fP.
-
 .SS History List Management
 These functions manage individual entries on the history list, or set
 parameters managing the list itself.
@@ -451,9 +449,7 @@ .SS History List Management
 
 .F1 int history_is_stifled "void"
 Returns non-zero if the history is stifled, zero if it is not.
-
 .SS Information About the History List
-
 These functions return information about the entire history list or
 individual list entries.
 
@@ -484,9 +480,7 @@ .SS Information About the History List
 Return the number of bytes that the primary history entries are using.
 This function returns the sum of the lengths of all the lines in the
 history.
-
 .SS Moving Around the History List
-
 These functions allow the current index into the history list to be
 set or changed.
 
@@ -507,9 +501,7 @@ .SS Moving Around the History List
 If the possibly-incremented history offset refers to a valid history
 entry, return a pointer to that entry;
 otherwise, return a \fBNULL\fP pointer.
-
 .SS Searching the History List
-
 These functions allow searching of the history list for entries containing
 a specific string.  Searching may be performed both forward and backward
 from the current history position.  The search may be \fIanchored\fP,
@@ -539,7 +531,6 @@ .SS Searching the History List
 absolute index into the list.  If \fIdirection\fP is negative, the search
 proceeds backward from \fIpos\fP, otherwise forward.  Returns the absolute
 index of the history element where \fIstring\fP was found, or -1 otherwise.
-
 .SS Managing the History File
 The History library can read the history from and write it to a file.
 This section documents the functions for managing a history file.
@@ -574,9 +565,7 @@ .SS Managing the History File
 \fInlines\fP lines.
 If \fIfilename\fP is \fBNULL\fP, then \fI\*~/.history\fP is truncated.
 Returns 0 on success, or \fBerrno\fP on failure.
-
 .SS History Expansion
-
 These functions implement history expansion.
 
 .F2 int history_expand "const char *string" "char **output"
@@ -623,9 +612,7 @@ .SS History Expansion
 Extract a string segment consisting of the \fIfirst\fP through \fIlast\fP
 arguments present in \fIstring\fP.  Arguments are split using
 \fBhistory_tokenize()\fP.
-
 .SS History Variables
-
 This section describes the externally-visible variables exported by
 the GNU History Library.
 
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]