From 922bd2fe521d82909a589ed503583e68b1007705 Mon Sep 17 00:00:00 2001
From: DanielEScherzer <daniel.e.scherzer@gmail.com>
Date: Fri, 25 Oct 2024 09:35:48 -0700
Subject: [PATCH] ext/readline: update return typehints from `bool` to `true`
 (#16545)

These always return true
---
 UPGRADING                       | 5 +++++
 ext/readline/readline.stub.php  | 6 +++---
 ext/readline/readline_arginfo.h | 8 ++++----
 3 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/UPGRADING b/UPGRADING
index 6a7a54f71745c..20bc84758744a 100644
--- a/UPGRADING
+++ b/UPGRADING
@@ -100,6 +100,11 @@ PHP 8.5 UPGRADE NOTES
 9. Other Changes to Extensions
 ========================================
 
+- Readline:
+  . The return types of readline_add_history(), readline_clear_history(), and
+    readline_callback_handler_install() have been changed to true, rather
+    than bool.
+
 ========================================
 10. New Global Constants
 ========================================
diff --git a/ext/readline/readline.stub.php b/ext/readline/readline.stub.php
index 0b31b09006d96..be445df214155 100644
--- a/ext/readline/readline.stub.php
+++ b/ext/readline/readline.stub.php
@@ -13,9 +13,9 @@ function readline(?string $prompt = null): string|false {}
 /** @param int|string|bool|null $value */
 function readline_info(?string $var_name = null, $value = null): mixed {}
 
-function readline_add_history(string $prompt): bool {}
+function readline_add_history(string $prompt): true {}
 
-function readline_clear_history(): bool {}
+function readline_clear_history(): true {}
 
 #ifdef HAVE_HISTORY_LIST
 /**
@@ -33,7 +33,7 @@ function readline_completion_function(callable $callback): bool {}
 
 
 #ifdef HAVE_RL_CALLBACK_READ_CHAR
-function readline_callback_handler_install(string $prompt, callable $callback): bool {}
+function readline_callback_handler_install(string $prompt, callable $callback): true {}
 
 function readline_callback_read_char(): void {}
 
diff --git a/ext/readline/readline_arginfo.h b/ext/readline/readline_arginfo.h
index 804a49eb525a5..c6fa7ee4590fc 100644
--- a/ext/readline/readline_arginfo.h
+++ b/ext/readline/readline_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: 7b72b1af4217ac8647096cb7e2c239466949cbd2 */
+ * Stub hash: 7a314f75d9a89a9ea4d525515bb6bacdf7be6746 */
 
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_readline, 0, 0, MAY_BE_STRING|MAY_BE_FALSE)
 	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, prompt, IS_STRING, 1, "null")
@@ -10,11 +10,11 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_readline_info, 0, 0, IS_MIXED, 0
 	ZEND_ARG_INFO_WITH_DEFAULT_VALUE(0, value, "null")
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_readline_add_history, 0, 1, _IS_BOOL, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_readline_add_history, 0, 1, IS_TRUE, 0)
 	ZEND_ARG_TYPE_INFO(0, prompt, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_readline_clear_history, 0, 0, _IS_BOOL, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_readline_clear_history, 0, 0, IS_TRUE, 0)
 ZEND_END_ARG_INFO()
 
 #if defined(HAVE_HISTORY_LIST)
@@ -33,7 +33,7 @@ ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_readline_completion_function, 0,
 ZEND_END_ARG_INFO()
 
 #if defined(HAVE_RL_CALLBACK_READ_CHAR)
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_readline_callback_handler_install, 0, 2, _IS_BOOL, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_readline_callback_handler_install, 0, 2, IS_TRUE, 0)
 	ZEND_ARG_TYPE_INFO(0, prompt, IS_STRING, 0)
 	ZEND_ARG_TYPE_INFO(0, callback, IS_CALLABLE, 0)
 ZEND_END_ARG_INFO()