bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 057/177] man/curs_ins{,_w}str.3x: Clarify behavior of negative `n


From: G. Branden Robinson
Subject: [PATCH 057/177] man/curs_ins{,_w}str.3x: Clarify behavior of negative `n` argument.
Date: Mon, 13 Jan 2025 11:23:38 -0600

* Any negative value of the `n` argument behaves the same way.
* Add "EXTENSIONS" section documenting this behavior as such.
* Add advice on extension usage to "PORTABILITY" section.
---
 man/curs_ins_wstr.3x | 20 ++++++++++++++++++--
 man/curs_insstr.3x   | 20 ++++++++++++++++++--
 2 files changed, 36 insertions(+), 4 deletions(-)

diff --git a/man/curs_ins_wstr.3x b/man/curs_ins_wstr.3x
index b357a6dfd..edd0a8230 100644
--- a/man/curs_ins_wstr.3x
+++ b/man/curs_ins_wstr.3x
@@ -103,8 +103,7 @@ .SH DESCRIPTION
 (up to the end of the line)
 if
 .I n
-is
-.BR \-1 "."
+is negative.
 \fB\%ncurses\fP(3X) describes the variants of these functions.
 .SH RETURN VALUE
 These functions return
@@ -144,7 +143,24 @@ .SH NOTES
 All of these functions except
 .B \%wins_nwstr
 may be implemented as macros.
+.SH EXTENSIONS
+.BR \%ins_nwstr ","
+.BR \%wins_nwstr ","
+.BR \%mvins_nwstr ","
+and
+.BR \%mvwins_nwstr "'s
+acceptance of negative
+.I n
+values is an
+.I \%ncurses
+extension.
 .SH PORTABILITY
+Applications employing
+.I \%ncurses
+extensions should condition their use on the visibility of the
+.B \%NCURSES_VERSION
+preprocessor macro.
+.PP
 X/Open Curses Issue\ 4 describes these functions.
 It specifies no error conditions for them.
 .PP
diff --git a/man/curs_insstr.3x b/man/curs_insstr.3x
index fc3f1768d..888270f5c 100644
--- a/man/curs_insstr.3x
+++ b/man/curs_insstr.3x
@@ -102,8 +102,7 @@ .SH DESCRIPTION
 (up to the end of the line)
 if
 .I n
-is
-.BR \-1 "."
+is negative.
 \fB\%ncurses\fP(3X) describes the variants of these functions.
 .SH RETURN VALUE
 These functions return
@@ -139,7 +138,24 @@ .SH NOTES
 All of these functions except
 .B \%winsnstr
 may be implemented as macros.
+.SH EXTENSIONS
+.BR \%insnstr ","
+.BR \%winsnstr ","
+.BR \%mvinsnstr ","
+and
+.BR \%mvwinsnstr "'s
+acceptance of negative
+.I n
+values is an
+.I \%ncurses
+extension.
 .SH PORTABILITY
+Applications employing
+.I \%ncurses
+extensions should condition their use on the visibility of the
+.B \%NCURSES_VERSION
+preprocessor macro.
+.PP
 X/Open Curses Issue\ 4 describes these functions.
 It specifies no error conditions for them.
 .PP
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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