NetBSD Problem Report #46941

From www@NetBSD.org  Tue Sep 11 11:20:12 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 974FF63DFCB
	for <gnats-bugs@gnats.NetBSD.org>; Tue, 11 Sep 2012 11:20:12 +0000 (UTC)
Message-Id: <20120911112011.C871863DDBB@www.NetBSD.org>
Date: Tue, 11 Sep 2012 11:20:11 +0000 (UTC)
From: sdaoden@gmail.com
Reply-To: sdaoden@gmail.com
To: gnats-bugs@NetBSD.org
Subject: Properly document EL_UNBUFFERED.
X-Send-Pr-Version: www-1.0

>Number:         46941
>Category:       lib
>Synopsis:       Properly document EL_UNBUFFERED.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    lib-bug-people
>State:          closed
>Class:          change-request
>Submitter-Id:   net
>Arrival-Date:   Tue Sep 11 11:25:00 +0000 2012
>Closed-Date:    Fri Jun 20 12:39:35 +0000 2014
>Last-Modified:  Fri Jun 20 12:39:35 +0000 2014
>Originator:     Steffen Nurpmeso
>Release:        netbsd-6-base
>Organization:
>Environment:
None.  netbsd-6-base as of 08-31, manually patched up.
>Description:
Doc yet for el_set() only.
Document just the same as for the others.
>How-To-Repeat:
Be a greenhorn, read el_get() only.  Give up.
>Fix:
    Document EL_UNBUFFERED for el_set()

diff --git a/src/lib/libedit/editline.3 b/src/lib/libedit/editline.3
index 9d06fbc..d44037c 100644
--- a/src/lib/libedit/editline.3
+++ b/src/lib/libedit/editline.3
@@ -432,6 +432,14 @@ check this
 (using
 .Fn el_get )
 to determine if editing should be enabled or not.
+.It Dv EL_UNBUFFERED , Fa "int flag"
+If
+.Fa flag
+is zero,
+unbuffered mode is disabled (the default).
+In unbuffered mode,
+.Fn el_gets
+will return immediately after processing a single character.
 .It Dv EL_GETCFN , Fa "int (*f)(EditLine *, char *c)"
 Define the character reading function as
 .Fa f ,
@@ -534,10 +542,7 @@ previously registered with the corresponding
 .Fn el_set
 call.
 .It Dv EL_UNBUFFERED , Fa "int"
-Sets or clears unbuffered mode.
-In this mode,
-.Fn el_gets
-will return immediately after processing a single character.
+Return non-zero if unbuffered mode is enabled.
 .It Dv EL_PREP_TERM , Fa "int"
 Sets or clears terminal editing mode.
 .It Dv EL_GETFP , Fa "int fd", Fa "FILE **fp"

>Release-Note:

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

 Module Name:	src
 Committed By:	christos
 Date:		Tue Sep 11 11:57:19 UTC 2012

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

 Log Message:
 PR/46941: Steffen Nurpmeso: document EL_BUFFERED


 To generate a diff of this commit:
 cvs rdiff -u -r1.75 -r1.76 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:39:35 +0000
State-Changed-Why:
christos@ fixed this two years ago


>Unformatted:

Home	PR Database Search