Skip to content

[Sync-En] ext/readline: document the functions unavailable where the feature is not supported #3471

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
lacatoire merged 1 commit into from
Sep 1, 2026
Merged

[Sync-En] ext/readline: document the functions unavailable where the feature is not supported #3471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion language-snippets.ent
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 9e5166dc6a5ff650b649298470d19eb7c3637a63 Maintainer: lacatoire Status: ready -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: lacatoire Status: ready -->
<!-- Relecture des Notes, Précautions, Avertissements, Astuces, Divers et Retour le 2018-12-29 par girgias -->

<!--
Expand Down Expand Up @@ -4842,6 +4842,15 @@ anglais. On devrait penser à leur utilité :
</informaltable>
'>

<!-- readline -->
<!ENTITY readline.system-callback-support '
<simpara xmlns="http://docbook.org/ns/docbook">
Cette fonction est disponible uniquement si la bibliothèque readline avec
laquelle PHP a été compilé la prend en charge. Elle est indisponible sur
Windows.
</simpara>
'>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
9 changes: 5 additions & 4 deletions reference/readline/book.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: yannick Status: ready -->
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.readline">
<?phpdoc extension-membership="bundledexternal" ?>
<title>GNU Readline</title>
Expand All @@ -22,7 +20,10 @@
<link linkend="features.commandline">ligne de commande</link>.
</simpara>
<simpara>
À partir de PHP 7.1.0 cette extension est supportée sur Windows. </simpara>
À partir de PHP 7.1.0 cette extension est supportée sur Windows, où elle est
compilée avec libedit. Toutes les fonctions ne sont pas présentes dans cette
compilation ; voir <link linkend="readline.requirements">les prérequis</link>.
</simpara>
<caution>
<simpara>
L'extension readline n'est pas thread-safe ! Par conséquent l'usage de celle-ci
Expand Down
4 changes: 2 additions & 2 deletions reference/readline/functions/readline-callback-handler-install.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: be246a268d0d5ab0b215c429cb031e70c98327ef Maintainer: lacatoire Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: lacatoire Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-callback-handler-install">
<refnamediv>
<refname>readline_callback_handler_install</refname>
Expand All @@ -27,6 +26,7 @@
l'interconnexion IO / entrée utilisateur, à la différence de
<function>readline</function>.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand Down
5 changes: 2 additions & 3 deletions reference/readline/functions/readline-callback-handler-remove.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: yannick Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-callback-handler-remove">
<refnamediv>
<refname>readline_callback_handler_remove</refname>
Expand All @@ -18,6 +16,7 @@
Efface un gestionnaire de rappel installé précédemment et restaure les
paramètres du terminal.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand Down
5 changes: 2 additions & 3 deletions reference/readline/functions/readline-callback-read-char.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: yannick Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-callback-read-char">
<refnamediv>
<refname>readline_callback_read_char</refname>
Expand All @@ -20,6 +18,7 @@
<function>readline_callback_handler_install</function>
qu'une ligne est prête à être entrée.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand Down
9 changes: 6 additions & 3 deletions reference/readline/functions/readline-list-history.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: yannick Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-list-history">
<refnamediv>
<refname>readline_list_history</refname>
Expand All @@ -17,6 +15,11 @@
<simpara>
Liste l'historique.
</simpara>
<simpara>
Cette fonction est disponible uniquement si la bibliothèque readline avec
laquelle PHP a été compilé fournit le listage de l'historique. C'est toujours
le cas avec GNU Readline et sur Windows.
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand Down
18 changes: 7 additions & 11 deletions reference/readline/functions/readline-on-new-line.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: yannick Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-on-new-line">
<refnamediv>
<refname>readline_on_new_line</refname>
Expand All @@ -17,6 +15,7 @@
<simpara>
Informe readline que le curseur est passé à une nouvelle ligne.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand All @@ -31,14 +30,11 @@
</simpara>
</refsect1>

<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
Cette fonction n'est disponible que si elle est supportée par la
bibliothèque readline sous-jacente. Elle n'est pas supportée sur Windows.
</simpara>
</note>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>readline_callback_handler_install</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Expand Down
12 changes: 9 additions & 3 deletions reference/readline/functions/readline-redisplay.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: yannick Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-redisplay">
<refnamediv>
<refname>readline_redisplay</refname>
Expand All @@ -17,6 +15,7 @@
<simpara>
Demande à readline de refaire l'affichage.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand All @@ -30,6 +29,13 @@
&return.void;
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>readline_callback_handler_install</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
19 changes: 16 additions & 3 deletions reference/readline/setup.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: yannick Status: ready -->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="readline.setup">
&reftitle.setup;

Expand All @@ -20,6 +18,21 @@
et disponible en téléchargement sur
<link xlink:href="&url.libedit;">&url.libedit;</link>.
</simpara>
<simpara>
Les deux bibliothèques ne fournissent pas les mêmes fonctionnalités, si bien
que certaines fonctions sont absentes de certaines compilations. Les fonctions
qui pilotent l'interface de rappel,
<function>readline_callback_handler_install</function>,
<function>readline_callback_handler_remove</function>,
<function>readline_callback_read_char</function>,
<function>readline_redisplay</function> et
<function>readline_on_new_line</function>, ne sont présentes que si la
bibliothèque sous-jacente les fournit, et sont absentes sur Windows. Appeler
une fonction absente lève une <exceptionname>Error</exceptionname>.
<function>function_exists</function> teste la présence d'une fonction donnée,
et la constante <constant>READLINE_LIB</constant> indique quelle bibliothèque
est utilisée.
</simpara>
</section>
<!-- }}} -->

Expand Down
Loading