[PATCH 102/177] man/curs_inchstr.3x: Revise "PORTABILITY" section.

[G. Branden Robinson]

Content:
* Relocate X/Open Curses's return value (lack of) prescriptions from
  "RETURN VALUE" section to "PORTABILITY".
* Expand discussion of trailing null character handling.  Annotate
  source material.

Markup:
* Favor man(7) font style macros over *roff font selection escape
  sequences, except for man page cross references (because
  man/make_sed.sh recognizes only certain patterns when rewriting such
  cross references) and terms in the "NAME" section (because the
  generated edit_man.sh script expects font selection escape sequences
  when scraping terms thence to gather names for man page aliases).
---
 man/curs_inchstr.3x | 31 +++++++++++++++++++++----------
 1 file changed, 21 insertions(+), 10 deletions(-)

diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x
index b9537d171..4884b9149 100644
--- a/man/curs_inchstr.3x
+++ b/man/curs_inchstr.3x
@@ -108,11 +108,6 @@ .SH NOTES
 .B \%winchnstr
 may be implemented as macros.
 .PP
-SVr4 does not
-document whether the result string is zero-terminated; it does not document
-whether a length limit argument includes any trailing 0; and it does not
-document the meaning of the return value.
-.PP
 Reading a line that overflows the array pointed to by
 \fIchstr\fP
 with
@@ -129,11 +124,27 @@ .SH NOTES
 \fBwinchnstr\fP
 is recommended.
 .SH PORTABILITY
-These functions are described in X/Open Curses Issue\ 4.
-It is no
-more specific than the SVr4 documentation on the trailing 0.
-It does specify
-that the successful return of the functions is \fBOK\fP.
+X/Open Curses Issue\ 4 describes these functions.
+It specifies no error conditions for them.
+It characterizes the strings stored by these functions as containing
+\*(``at most
+.I n
+elements\*('' from a window,
+.\" X/Open Issue 4, Version 2, p. 113, PDF p. 133
+.\" Issue 7 doesn't change this wording at all.
+but does not specify whether the string stored by these functions is
+null-terminated.
+.PP
+SVr4 does not document whether it null-terminates the string it stores
+in
+.IR chstr ","
+and does not document whether a trailing null chracter counts toward the
+length limit
+.IR n "."
+.PP
+SVr4 describes a successful return value only as
+\*(``an integer value other than
+.IR ERR \*(''. \" Courier roman in source; SVID 4, vol. 3, p. 503
 .SH SEE ALSO
 \fB\%curses\fP(3X),
 \fB\%curs_inch\fP(3X),
-- 
2.30.2

signature.asc
Description: PGP signature