Skip to content

Remove GNU Readline in favor of libedit #3745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 23, 2024
Merged

Remove GNU Readline in favor of libedit #3745

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd0a61c
Remove GNU Readline in favor of libedit
petk Sep 14, 2024
791cc1d
Replace personalization
petk Sep 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions reference/readline/book.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@

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

<!-- {{{ preface -->
<preface xml:id="intro.readline">
&reftitle.intro;
<para>
The readline functions implement an interface
to the GNU Readline library. These are functions that provide
to the libedit library. These are functions that provide
editable command lines. An example being the way Bash allows you
to use the arrow keys to insert characters or scroll through
command history. Because of the interactive nature of this
Expand Down
32 changes: 29 additions & 3 deletions reference/readline/configure.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,39 @@
<para>
To use these functions you must compile the CGI or CLI version of PHP
with readline support. You need to configure PHP
<option role="configure">--with-readline[=DIR]</option>.
If you want to use the libedit readline replacement, configure PHP
<option role="configure">--with-libedit[=DIR]</option>.
<option role="configure">--with-readline</option>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note the documentation shouldn't use personalization (i.e. using "you") maybe you could fix the text at the same time?

This feels like this should probably use some standard wording/an existing XML entity

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in the next commit. I'm not sure I know what "standard wording/an existing XML entity" means here.

</para>
<para>
On Windows this extension is available by default as of PHP 7.1.0.
</para>
<simplesect role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
Configure option <option role="configure">--with-libedit</option>
has been removed in favor of the
<option role="configure">--with-readline</option> which now doesn't
accept a DIR argument anymore in favor of the pkg-config and now links
to the libedit library, a non-GPL replacement for the GNU Readline
library.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</simplesect>
</section>

<!-- Keep this comment at the end of the file
Expand Down
39 changes: 25 additions & 14 deletions reference/readline/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,31 @@
<appendix xml:id="readline.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry xml:id="constant.readline-lib">
<term>
<constant>READLINE_LIB</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
The library which is used for readline support; currently either
<literal>readline</literal> or <literal>libedit</literal>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
<formalpara>
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
The <constant>READLINE_LIB</constant> has been removed. The library
which is used for readline support; either <literal>readline</literal>
or <literal>libedit</literal>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</formalpara>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
10 changes: 2 additions & 8 deletions reference/readline/setup.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,8 @@
<section xml:id="readline.requirements">
&reftitle.required;
<para>
To use the readline functions, you need to install libreadline. You can
find libreadline on the home page of the GNU Readline project, at
<link xlink:href="&url.readline;">&url.readline;</link>.
It's maintained by Chet Ramey, who's also the author of Bash.
</para>
<para>
You can also use these functions with the libedit library, a non-GPL
replacement for the readline library. The libedit library is BSD
To use the readline functions, you need to install the libedit library, a
non-GPL replacement for the GNU Readline library. The libedit library is BSD
licensed and available for download from
<link xlink:href="&url.libedit;">&url.libedit;</link>.
</para>
Expand Down