Subject: misc/35411: inconsistency in editline(3)
To: None <misc-bug-people@netbsd.org, gnats-admin@netbsd.org,>
From: None <mattwala@gmail.com>
List: netbsd-bugs
Date: 01/12/2007 07:05:00
>Number:         35411
>Category:       misc
>Synopsis:       inconsistency in editline(3)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Fri Jan 12 07:05:00 +0000 2007
>Originator:     Matthew Wala
>Release:        4.99.7
>Organization:
>Environment:
NetBSD waldo.local 4.99.7 NetBSD 4.99.7 (GENERIC) #4: Sun Jan  7 05:16:19 UTC 2007  root@waldo.local:/cdsources/obj/sys/arch/macppc/compile/GENERIC macppc

>Description:
The synopsis for the el_deletestr function in the editline(3) manpage is:

void el_deletestr(EditLine *e, int count);

However, the description section states:

Delete num characters before the cursor.

Either "count" or "num" should be used as a variable name, not both.
>How-To-Repeat:
man el_deletestr
>Fix:
"num characters" sounds better (and there is a precedent in src/lib/libedit/chared.c), so:
--- editline.3	2006-12-17 18:03:43.000000000 -0600
+++ editline.3	2007-01-12 00:56:09.000000000 -0600
@@ -88,7 +88,7 @@
 .Ft int
 .Fn el_insertstr "EditLine *e" "const char *str"
 .Ft void
-.Fn el_deletestr "EditLine *e" "int count"
+.Fn el_deletestr "EditLine *e" "int num"
 .Ft History *
 .Fn history_init
 .Ft void