Improve documentation and GUC description for transaction_timeout

akorotkov · akorotkov · commit 28e858c0f951 · 2024-02-25T20:30:17.000+02:00
Reported-by: Alexander Lakhin
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
@@ -9167,7 +9167,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
       <listitem>
        <para>
         Terminate any session that spans longer than the specified amount of
-        time in the transaction. The limit applies both to explicit transactions
+        time in a transaction. The limit applies both to explicit transactions
         (started with <command>BEGIN</command>) and to an implicitly started
         transaction corresponding to a single statement.
         If this value is specified without units, it is taken as milliseconds.
@@ -9177,7 +9177,7 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
        <para>
         If <varname>transaction_timeout</varname> is shorter or equal to
         <varname>idle_in_transaction_session_timeout</varname> or <varname>statement_timeout</varname>
-        <varname>transaction_timeout</varname> will invalidate the longer timeout.
+        then the longer timeout is ignored.
        </para>
 
        <para>
diff --git a/src/backend/utils/misc/guc_tables.c b/src/backend/utils/misc/guc_tables.c
@@ -2589,7 +2589,7 @@ struct config_int ConfigureNamesInt[] =
 
 	{
 		{"transaction_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
-			gettext_noop("Sets the maximum allowed time in a transaction with a session (not a prepared transaction)."),
+			gettext_noop("Sets the maximum allowed duration of any transaction within a session (not a prepared transaction)."),
 			gettext_noop("A value of 0 turns off the timeout."),
 			GUC_UNIT_MS
 		},

Original file line number	Diff line number	Diff line change
`@@ -2589,7 +2589,7 @@ struct config_int ConfigureNamesInt[] =`
`2589`	`2589`
`2590`	`2590`	`{`
`2591`	`2591`	`{"transaction_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,`
`2592`		`- gettext_noop("Sets the maximum allowed time in a transaction with a session (not a prepared transaction)."),`
	`2592`	`+ gettext_noop("Sets the maximum allowed duration of any transaction within a session (not a prepared transaction)."),`
`2593`	`2593`	`gettext_noop("A value of 0 turns off the timeout."),`
`2594`	`2594`	`GUC_UNIT_MS`
`2595`	`2595`	`},`