Bug 25294 - readline man page out of date, but not marked as such
readline man page out of date, but not marked as such
Status: CLOSED RAWHIDE
Product: Red Hat Linux
Classification: Retired
Component: readline (Show other bugs)
6.2
i386 Linux
medium Severity medium
: ---
: ---
Assigned To: Nalin Dahyabhai
David Lawrence
:
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2001-01-30 07:25 EST by Reuben Thomas
Modified: 2007-04-18 12:30 EDT (History)
0 users

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed: 2001-01-30 16:36:10 EST
Type: ---
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:


Attachments (Terms of Use)

  None (edit)
Description Reuben Thomas 2001-01-30 07:25:20 EST
The readline man page is woefully inaccurate, and I just wasted a little
while by believing it. Eventually I just read the info manual.

Suggestion: remove the man page, or at least put a notice saying "it's way
out of date", the way that many GNU manpages do.
Comment 1 Nalin Dahyabhai 2001-01-30 15:13:54 EST
Which parts?  The function appears to work when it's called as the man page
suggests that it should be....
Comment 2 Reuben Thomas 2001-01-30 15:18:08 EST
If you compare the manpage and the info page, you'll find that there are some
significant differences. The two that bit me were:

1.  In the manpage it says that readline() returns EOF when Ctrl+D is pressed at
the beginning of a line. In the info page it says (correctly) that it returns
NULL in this case.

2. In the manpage it says that the default keybinding for Newline/Enter places
the line you've just typed in the history. In the info page it says that you
have to call add_history() to make this happen.
Comment 3 Nalin Dahyabhai 2001-01-30 16:36:06 EST
I've just sent mail to the listed contact for the man page, asking for
suggestions on which course of action to take.
Comment 4 Nalin Dahyabhai 2001-01-30 16:50:42 EST
Chet tells me that an updated version will be in readline 4.2, and until then
it's best to add a note to the man page about it being out-of-date.  This will
be done in readline-4.1-

Note You need to log in before you can comment on or make changes to this bug.