diff options
| author | Noah Misch | 2021-06-15 00:29:37 +0000 |
|---|---|---|
| committer | Noah Misch | 2021-06-15 00:29:37 +0000 |
| commit | 0aac73e6a2602696d23aa7a9686204965f9093dc (patch) | |
| tree | bcef2d4f256f9a045de2141b7b7e3fe1e782c6f3 | |
| parent | 33c509956704e1d918077b51ccd954f2e201a8f5 (diff) | |
Copy-edit text for the pg_terminate_backend() "timeout" parameter.
Revert the pg_description entry to its v13 form, since those messages
usually remain shorter and don't discuss individual parameters. No
catversion bump, since pg_description content does not impair backend
compatibility or application compatibility.
Justin Pryzby
Discussion: https://postgr.es/m/[email protected]
| -rw-r--r-- | doc/src/sgml/func.sgml | 2 | ||||
| -rw-r--r-- | src/backend/storage/ipc/signalfuncs.c | 14 | ||||
| -rw-r--r-- | src/include/catalog/pg_proc.dat | 3 |
3 files changed, 9 insertions, 10 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index fbc80c1403..b7383bc8aa 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -24998,7 +24998,7 @@ SELECT collation for ('foo' COLLATE "de_DE"); milliseconds) and greater than zero, the function waits until the process is actually terminated or until the given time has passed. If the process is terminated, the function - returns <literal>true</literal>. On timeout a warning is emitted and + returns <literal>true</literal>. On timeout, a warning is emitted and <literal>false</literal> is returned. </para></entry> </row> diff --git a/src/backend/storage/ipc/signalfuncs.c b/src/backend/storage/ipc/signalfuncs.c index 837699481c..0a111ad6da 100644 --- a/src/backend/storage/ipc/signalfuncs.c +++ b/src/backend/storage/ipc/signalfuncs.c @@ -187,12 +187,12 @@ pg_wait_until_termination(int pid, int64 timeout) } /* - * Signal to terminate a backend process. This is allowed if you are a member - * of the role whose process is being terminated. If timeout input argument is - * 0 (which is default), then this function just signals the backend and - * doesn't wait. Otherwise it waits until given the timeout milliseconds or no - * process has the given PID and returns true. On timeout, a warning is emitted - * and false is returned. + * Send a signal to terminate a backend process. This is allowed if you are a + * member of the role whose process is being terminated. If the timeout input + * argument is 0, then this function just signals the backend and returns + * true. If timeout is nonzero, then it waits until no process has the given + * PID; if the process ends within the timeout, true is returned, and if the + * timeout is exceeded, a warning is emitted and false is returned. * * Note that only superusers can signal superuser-owned processes. */ @@ -201,7 +201,7 @@ pg_terminate_backend(PG_FUNCTION_ARGS) { int pid; int r; - int timeout; + int timeout; /* milliseconds */ pid = PG_GETARG_INT32(0); timeout = PG_GETARG_INT64(1); diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index acbcae4607..83eea85cf6 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -6186,8 +6186,7 @@ { oid => '2171', descr => 'cancel a server process\' current query', proname => 'pg_cancel_backend', provolatile => 'v', prorettype => 'bool', proargtypes => 'int4', prosrc => 'pg_cancel_backend' }, -{ oid => '2096', - descr => 'terminate a backend process and if timeout is specified, wait for its exit or until timeout occurs', +{ oid => '2096', descr => 'terminate a server process', proname => 'pg_terminate_backend', provolatile => 'v', prorettype => 'bool', proargtypes => 'int4 int8', proargnames => '{pid,timeout}', prosrc => 'pg_terminate_backend' }, |