Skip to content

Commit b9582e1

Browse files
authored
Remove GNU Readline in favor of libedit (#3745)
The libedit library is a non-GPL replacement for the GNU Readline library.
1 parent 4a87d61 commit b9582e1

File tree

4 files changed

+59
-29
lines changed

4 files changed

+59
-29
lines changed

reference/readline/book.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33

44
<book xml:id="book.readline" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
55
<?phpdoc extension-membership="bundledexternal" ?>
6-
<title>GNU Readline</title>
6+
<title>Readline</title>
77
<titleabbrev>Readline</titleabbrev>
88

99
<!-- {{{ preface -->
1010
<preface xml:id="intro.readline">
1111
&reftitle.intro;
1212
<para>
1313
The readline functions implement an interface
14-
to the GNU Readline library. These are functions that provide
14+
to the libedit library. These are functions that provide
1515
editable command lines. An example being the way Bash allows you
1616
to use the arrow keys to insert characters or scroll through
1717
command history. Because of the interactive nature of this

reference/readline/configure.xml

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,41 @@
33
<section xml:id="readline.installation" xmlns="http://docbook.org/ns/docbook">
44
&reftitle.install;
55
<para>
6-
To use these functions you must compile the CGI or CLI version of PHP
6+
To use these functions the CGI or CLI version of PHP must be compiled
77
with readline support. You need to configure PHP
8-
<option role="configure">--with-readline[=DIR]</option>.
9-
If you want to use the libedit readline replacement, configure PHP
10-
<option role="configure">--with-libedit[=DIR]</option>.
8+
<option role="configure">--with-readline</option>.
119
</para>
1210
<para>
1311
On Windows this extension is available by default as of PHP 7.1.0.
1412
</para>
13+
<simplesect role="changelog">
14+
&reftitle.changelog;
15+
<para>
16+
<informaltable>
17+
<tgroup cols="2">
18+
<thead>
19+
<row>
20+
<entry>&Version;</entry>
21+
<entry>&Description;</entry>
22+
</row>
23+
</thead>
24+
<tbody>
25+
<row>
26+
<entry>8.4.0</entry>
27+
<entry>
28+
Configure option <option role="configure">--with-libedit</option>
29+
has been removed in favor of the
30+
<option role="configure">--with-readline</option> which now doesn't
31+
accept a DIR argument anymore in favor of the pkg-config and now links
32+
to the libedit library, a non-GPL replacement for the GNU Readline
33+
library.
34+
</entry>
35+
</row>
36+
</tbody>
37+
</tgroup>
38+
</informaltable>
39+
</para>
40+
</simplesect>
1541
</section>
1642

1743
<!-- Keep this comment at the end of the file

reference/readline/constants.xml

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,31 @@
33
<appendix xml:id="readline.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
44
&reftitle.constants;
55
&extension.constants;
6-
<variablelist>
7-
<varlistentry xml:id="constant.readline-lib">
8-
<term>
9-
<constant>READLINE_LIB</constant>
10-
(<type>string</type>)
11-
</term>
12-
<listitem>
13-
<simpara>
14-
The library which is used for readline support; currently either
15-
<literal>readline</literal> or <literal>libedit</literal>.
16-
</simpara>
17-
</listitem>
18-
</varlistentry>
19-
</variablelist>
6+
<formalpara>
7+
&reftitle.changelog;
8+
<para>
9+
<informaltable>
10+
<tgroup cols="2">
11+
<thead>
12+
<row>
13+
<entry>&Version;</entry>
14+
<entry>&Description;</entry>
15+
</row>
16+
</thead>
17+
<tbody>
18+
<row>
19+
<entry>8.4.0</entry>
20+
<entry>
21+
The <constant>READLINE_LIB</constant> has been removed. The library
22+
which is used for readline support; either <literal>readline</literal>
23+
or <literal>libedit</literal>.
24+
</entry>
25+
</row>
26+
</tbody>
27+
</tgroup>
28+
</informaltable>
29+
</para>
30+
</formalpara>
2031
</appendix>
2132
<!-- Keep this comment at the end of the file
2233
Local variables:

reference/readline/setup.xml

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,8 @@
88
<section xml:id="readline.requirements">
99
&reftitle.required;
1010
<para>
11-
To use the readline functions, you need to install libreadline. You can
12-
find libreadline on the home page of the GNU Readline project, at
13-
<link xlink:href="&url.readline;">&url.readline;</link>.
14-
It's maintained by Chet Ramey, who's also the author of Bash.
15-
</para>
16-
<para>
17-
You can also use these functions with the libedit library, a non-GPL
18-
replacement for the readline library. The libedit library is BSD
19-
licensed and available for download from
11+
To use the readline functions, the libedit library must be installed. The
12+
libedit library is BSD-licensed and available for download from
2013
<link xlink:href="&url.libedit;">&url.libedit;</link>.
2114
</para>
2215
</section>

0 commit comments

Comments
 (0)