Skip to content

readline: Document functions unavailable where feature is not supported #4923

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

Open
AllenJB wants to merge 5 commits into
base: master
Choose a base branch
from
Open

readline: Document functions unavailable where feature is not supported #4923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e13a035
readline: Document functions unavailable where feature is not support…
AllenJB Oct 13, 2025
c41ebfa
Merge remote-tracking branch 'origin/master' into readline_avail
AllenJB Jul 1, 2026
3a5d0fe
simpara fixes
AllenJB Jul 1, 2026
344078f
Move callback feature system support notice to an entity
AllenJB Jul 1, 2026
9241813
Update language-snippets.ent: Apply review suggestion (XML namespace)
AllenJB Jul 22, 2026
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
7 changes: 7 additions & 0 deletions language-snippets.ent
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4880,6 +4880,13 @@ xmlns="http://docbook.org/ns/docbook"><simpara>This function has been
</simpara>
'>

<!ENTITY readline.system-callback-support '
<simpara xmlns="http://docbook.org/ns/docbook">
This function is unavailable on Windows and other systems that do not support
the readline callback feature.
</simpara>
'>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
1 change: 1 addition & 0 deletions reference/readline/functions/readline-callback-handler-install.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
<function>stream_select</function> as it allows interleaving of IO and
user input, unlike <function>readline</function>.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand Down
1 change: 1 addition & 0 deletions reference/readline/functions/readline-callback-handler-remove.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
Removes a previously installed callback handler and restores terminal
settings.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand Down
1 change: 1 addition & 0 deletions reference/readline/functions/readline-callback-read-char.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
<function>readline_callback_handler_install</function> that a line
is ready for input.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand Down
4 changes: 4 additions & 0 deletions reference/readline/functions/readline-list-history.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
<simpara>
Gets the entire command line history.
</simpara>
<simpara>
This function is unavailable if this feature is not supported by readline on
your system.
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand Down
1 change: 1 addition & 0 deletions reference/readline/functions/readline-on-new-line.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<simpara>
Tells readline that the cursor has moved to a new line.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand Down
1 change: 1 addition & 0 deletions reference/readline/functions/readline-redisplay.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
<simpara>
Redraws readline to redraw the display.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand Down