[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 27/51] man/*.3x: Relocate discussion of X/Open Curses's lack of e
From: |
G. Branden Robinson |
Subject: |
[PATCH 27/51] man/*.3x: Relocate discussion of X/Open Curses's lack of error specification. |
Date: |
Fri, 26 Jul 2024 12:51:10 -0500 |
* man/curs_add_wchstr.3x:
* man/curs_addchstr.3x:
* man/curs_attr.3x:
* man/curs_border.3x:
* man/curs_outopts.3x:
* man/curs_pad.3x:
* man/curs_refresh.3x:
* man/curs_touch.3x:
* man/curs_util.3x: Move observation of X/Open Curses's lack of error
condition specification from "RETURN VALUE" section to "PORTABILITY"
section.
---
man/curs_add_wchstr.3x | 2 +-
man/curs_addchstr.3x | 2 +-
man/curs_attr.3x | 3 ++-
man/curs_border.3x | 2 +-
man/curs_outopts.3x | 3 +--
man/curs_pad.3x | 3 +--
man/curs_refresh.3x | 2 +-
man/curs_touch.3x | 5 ++---
man/curs_util.3x | 5 ++---
9 files changed, 12 insertions(+), 15 deletions(-)
diff --git a/man/curs_add_wchstr.3x b/man/curs_add_wchstr.3x
index d73cf6df8..c39d1763c 100644
--- a/man/curs_add_wchstr.3x
+++ b/man/curs_add_wchstr.3x
@@ -112,7 +112,6 @@ .SH RETURN VALUE
.B ERR
on failure.
.PP
-X/Open Curses does not specify any error conditions.
In
.IR \%ncurses ","
they return
@@ -140,6 +139,7 @@ .SH NOTES
.SH PORTABILITY
X/Open Curses,
Issue 4 describes these functions.
+It specifies no error conditions for them.
.SH HISTORY
These functions were initially specified by X/Open Curses,
Issue 4.
diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x
index 55556882a..8e164dc48 100644
--- a/man/curs_addchstr.3x
+++ b/man/curs_addchstr.3x
@@ -112,7 +112,6 @@ .SH RETURN VALUE
.B ERR
on failure.
.PP
-X/Open Curses does not specify any error conditions.
In
.IR \%ncurses ","
they return
@@ -140,6 +139,7 @@ .SH NOTES
.SH PORTABILITY
X/Open Curses,
Issue 4 describes these functions.
+It specifies no error conditions for them.
.SH SEE ALSO
\fB\%curs_add_wchstr\fP(3X) describes comparable functions of the
.I \%ncurses
diff --git a/man/curs_attr.3x b/man/curs_attr.3x
index d15995e25..6ceed816d 100644
--- a/man/curs_attr.3x
+++ b/man/curs_attr.3x
@@ -306,7 +306,6 @@ .SS "Video Attributes"
.SH RETURN VALUE
All routines return the integer \fBOK\fP on success, or \fBERR\fP on failure.
.PP
-X/Open Curses does not specify any error conditions.
.PP
This implementation
.bP
@@ -379,6 +378,8 @@ .SH EXTENSIONS
.\" ---------------------------------------------------------------------------
.SH PORTABILITY
These functions are described in X/Open Curses, Issue 4.
+It specifies no error conditions for them.
+.PP
The standard defined the dedicated type for highlights,
\fBattr_t\fP, which was not defined in SVr4 curses.
The functions taking \fBattr_t\fP arguments were not supported under SVr4.
diff --git a/man/curs_border.3x b/man/curs_border.3x
index d8990fb3b..9729bd3da 100644
--- a/man/curs_border.3x
+++ b/man/curs_border.3x
@@ -141,7 +141,6 @@ .SH RETURN VALUE
\*(``or a non-negative integer if \fB\%immedok\fP is set\*('',
but this appears to be an error.
.PP
-X/Open Curses does not specify any error conditions.
This implementation returns
.B ERR
if the window pointer is null.
@@ -158,6 +157,7 @@ .SH NOTES
Note that \fBborder\fP and \fBbox\fP may be macros.
.SH PORTABILITY
These functions are described in X/Open Curses, Issue 4.
+It specifies no error conditions for them.
.SH SEE ALSO
\fB\%curses\fP(3X),
\fB\%curs_outopts\fP(3X)
diff --git a/man/curs_outopts.3x b/man/curs_outopts.3x
index 414d9d08a..fe0f71122 100644
--- a/man/curs_outopts.3x
+++ b/man/curs_outopts.3x
@@ -143,8 +143,6 @@ .SH RETURN VALUE
All other routines that return an integer always
return \fBOK\fP.
.PP
-X/Open Curses does not specify any error conditions.
-.PP
In this implementation,
.bP
those functions that have a window pointer
@@ -169,6 +167,7 @@ .SH NOTES
emulators.
.SH PORTABILITY
These functions are described in X/Open Curses, Issue 4.
+It specifies no error conditions for them.
.PP
Some historic curses implementations had, as an undocumented feature, the
ability to do the equivalent of \fBclearok(..., 1)\fP by saying
diff --git a/man/curs_pad.3x b/man/curs_pad.3x
index d2fadb90d..15936bdca 100644
--- a/man/curs_pad.3x
+++ b/man/curs_pad.3x
@@ -186,7 +186,6 @@ .SH RETURN VALUE
to
.BR \%ENOMEM "."
.PP
-X/Open Curses does not specify any error conditions.
In this implementation
.RS 3
.TP 5
@@ -243,7 +242,7 @@ .SH PORTABILITY
.PP
X/Open Curses, Issue 4 describes these functions,
without significant change from the SVr3 documentation.
-It describes no error conditions.
+It specifies no error conditions for them.
The behavior of \fB\%subpad\fP if the parent window is not
a pad is undocumented,
and is not checked by the vendor Unix implementations:
diff --git a/man/curs_refresh.3x b/man/curs_refresh.3x
index a189ab3e5..b2122c183 100644
--- a/man/curs_refresh.3x
+++ b/man/curs_refresh.3x
@@ -133,7 +133,6 @@ .SH RETURN VALUE
\*(``an integer value other than \fBERR\fP\*('')
upon successful completion.
.PP
-X/Open Curses does not specify any error conditions.
In this implementation
.RS 3
.TP 5
@@ -153,6 +152,7 @@ .SH NOTES
Note that \fBrefresh\fP and \fBredrawwin\fP may be macros.
.SH PORTABILITY
X/Open Curses, Issue 4 describes these functions.
+It specifies no error conditions for them.
.PP
Whether \fBwnoutrefresh\fP copies to the virtual screen the entire contents
of a window or just its changed portions has never been well-documented in
diff --git a/man/curs_touch.3x b/man/curs_touch.3x
index ca90dce59..0f906094a 100644
--- a/man/curs_touch.3x
+++ b/man/curs_touch.3x
@@ -81,7 +81,6 @@ .SH RETURN VALUE
other than \fBERR\fP upon successful completion, unless otherwise noted in the
preceding routine descriptions.
.PP
-X/Open Curses does not specify any error conditions.
In this implementation
.RS 3
.TP 5
@@ -118,8 +117,8 @@ .SH PORTABILITY
that it is not \fBNULL\fP;
otherwise this implementation behaves the same as SVr4.
.PP
-X/Open Curses, Issue 4 describes these functions,
-but defines no error conditions.
+X/Open Curses, Issue 4 describes these functions.
+It specifies no error conditions for them.
.SH SEE ALSO
\fB\%curses\fP(3X),
\fB\%curs_refresh\fP(3X),
diff --git a/man/curs_util.3x b/man/curs_util.3x
index 74227f0d9..a6e04f2d6 100644
--- a/man/curs_util.3x
+++ b/man/curs_util.3x
@@ -310,7 +310,6 @@ .SH RETURN VALUE
.PP
Routines that return pointers return \fBNULL\fP on error.
.PP
-X/Open Curses does not specify any error conditions.
In this implementation
.RS 3
.TP 5
@@ -408,9 +407,9 @@ .SS "putwin/getwin file-format"
.SS "unctrl, wunctrl"
X/Open Curses,
Issue 4 describes these functions.
+It specifies no error conditions for them.
It states that \fBunctrl\fP and \fBwunctrl\fP will return a null pointer
-if unsuccessful,
-but does not define any error conditions.
+if unsuccessful.
This implementation checks for three cases:
.bP
the parameter is a 7-bit US\-ASCII code.
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 27/51] man/*.3x: Relocate discussion of X/Open Curses's lack of error specification.,
G. Branden Robinson <=