Skip to content

Commit dfab7f2

Browse files
committed
docs: Clarify that signal functions have no feedback.
Bug #16652 complains that pg_reload_conf() returned true, even though the configuration file contained errors. That's the way pg_reload_conf() works, by design, but the documentation wasn't very clear on it. Clarify that a 'true' return value only means that the signal was sent successfully. Also add links to the system views that can be used to check the configuration files for errors. David G. Johnston, with some rewording by me. Discussion: https://www.postgresql.org/message-id/CAKFQuwax6GxhUQEes0D045UtXG-fBraM39_6UMd5JyR5K1HWCQ%40mail.gmail.com
1 parent 6dd8b00 commit dfab7f2

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

doc/src/sgml/func.sgml

+6-2
Original file line numberDiff line numberDiff line change
@@ -23922,7 +23922,8 @@ SELECT collation for ('foo' COLLATE "de_DE");
2392223922

2392323923
<para>
2392423924
Each of these functions returns <literal>true</literal> if
23925-
successful and <literal>false</literal> otherwise.
23925+
the signal was successfully sent and <literal>false</literal>
23926+
if sending the signal failed.
2392623927
</para>
2392723928

2392823929
<table id="functions-admin-signal-table">
@@ -23970,7 +23971,10 @@ SELECT collation for ('foo' COLLATE "de_DE");
2397023971
server to reload their configuration files. (This is initiated by
2397123972
sending a <systemitem>SIGHUP</systemitem> signal to the postmaster
2397223973
process, which in turn sends <systemitem>SIGHUP</systemitem> to each
23973-
of its children.)
23974+
of its children.) You can use the
23975+
<link linkend="view-pg-file-settings">pg_file_settings</link> and
23976+
<link linkend="view-pg-hba-file-rules">pg_hba_file_rules</link> views
23977+
to check the configuration files for possible errors, before reloading.
2397423978
</para></entry>
2397523979
</row>
2397623980

0 commit comments

Comments
 (0)