NetBSD Problem Report #46945

From www@NetBSD.org  Tue Sep 11 15:27:54 2012
Return-Path: <www@NetBSD.org>
Received: from mail.netbsd.org (mail.netbsd.org [149.20.53.66])
	by www.NetBSD.org (Postfix) with ESMTP id 2A38163B9BC
	for <gnats-bugs@gnats.NetBSD.org>; Tue, 11 Sep 2012 15:27:54 +0000 (UTC)
Message-Id: <20120911152753.86B1263B86D@www.NetBSD.org>
Date: Tue, 11 Sep 2012 15:27:53 +0000 (UTC)
From: sdaoden@gmail.com
Reply-To: sdaoden@gmail.com
To: gnats-bugs@NetBSD.org
Subject: editline(3): el_getc() doesn't document it's setting errno
X-Send-Pr-Version: www-1.0

>Number:         46945
>Category:       lib
>Synopsis:       editline(3): el_getc() doesn't document it's setting errno
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    lib-bug-people
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Tue Sep 11 15:30:00 +0000 2012
>Closed-Date:    Fri Jun 20 12:43:25 +0000 2014
>Last-Modified:  Fri Jun 20 12:43:25 +0000 2014
>Originator:     Steffen Nurpmeso
>Release:        netbsd-6-base
>Organization:
>Environment:
netbsd-6-base, manually patched up
>Description:
Whereas el_gets() already documents that it sets errno on error,
el_getc() does not.
>How-To-Repeat:
Be a greenhorn.  Be undecided.
>Fix:
Applies also to v1.76

diff --git a/src/lib/libedit/editline.3 b/src/lib/libedit/editline.3
index 7540562..80819b2 100644
--- a/src/lib/libedit/editline.3
+++ b/src/lib/libedit/editline.3
@@ -221,7 +221,10 @@ and must be copied if the data is to be retained.
 Read a character from the tty.
 .Fa ch
 is modified to contain the character read.
-Returns the number of characters read if successful, \-1 otherwise.
+Returns the number of characters read if successful, \-1 otherwise,
+in which case
+.Dv errno
+can be inspected for the cause.
 .It Fn el_push
 Pushes
 .Fa str

>Release-Note:

>Audit-Trail:
From: "Christos Zoulas" <christos@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/46945 CVS commit: src/lib/libedit
Date: Tue, 11 Sep 2012 16:29:59 -0400

 Module Name:	src
 Committed By:	christos
 Date:		Tue Sep 11 20:29:59 UTC 2012

 Modified Files:
 	src/lib/libedit: editline.3

 Log Message:
 PR/46945: Steffen Nurpmeso; el_getc() doesn't document it's setting errno


 To generate a diff of this commit:
 cvs rdiff -u -r1.76 -r1.77 src/lib/libedit/editline.3

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

State-Changed-From-To: open->closed
State-Changed-By: riastradh@NetBSD.org
State-Changed-When: Fri, 20 Jun 2014 12:43:25 +0000
State-Changed-Why:
fixed


>Unformatted:

Home	PR Database Search