This isn't flagged with GUC_EXPLAIN:
enable_incremental_sort
Here's some more candidates:
shared_buffers - it seems unfortunate this is not included; actually, it seems
like maybe this should be always included - not just if it's set to a
non-default, but especially if it's left at the default..
I suppose it's more important for DML than SELECT.
temp_tablespaces isn't, but temp_buffers is;
autovacuum - if it's off, that can be the cause of the issue (same as
force_parallel_mode, which has GUC_EXPLAIN);
max_worker_processes - isn't, but these are: max_parallel_workers,
max_parallel_workers_per_gather;
track_io_timing - it can have high overhead;
session_preload_libraries, shared_preload_libraries, local_preload_libraries;
debug_assertions - it's be kind of nice to show this whenever it's true (even
thought it's not "changed")
debug_discard_caches
lc_collate and lc_ctype ?
server_version_num - I asked about this in the past, but Tom thought it should
not be included, and I kind of agree, but I'm including it here for
completeness sake
This isn't marked GUC_NOT_IN_SAMPLE, like all other DEVELOPER_OPTIONS:
trace_recovery_messages
I'm not sure jit_tuple_deforming should be marked GUC_NOT_IN_SAMPLE.
I disable this one because it's slow for tables with many attributes.
Same for jit_expressions ?
bgwriter_lru_maxpages should have GUC_UNIT_BLOCKS
max_identifier_length should have BYTES (like log_parameter_max_length and
track_activity_query_size).
block_size and wal_block_size should say BYTES (like wal_segment_size)
And all three descriptions should say ".. in [prefix]bytes" (but see below).
Maybe these should have COMPAT_OPTIONS_PREVIOUS:
integer_datetimes
ssl_renegotiation_limit
autovacuum_freeze_max_age has a comment about pg_resetwal which is obsolete
since 74cf7d46a.
checkpoint_warning refers to "checkpoint segments", which is obsolete since
88e982302.
The attached does the least-disputable, lowest hanging fruit.
More ideas:
Maybe maintenance_io_concurrency should not be GUC_EXPLAIN. But it's used not
only by ANALYZE but also heap_index_delete_tuples.
Should these be GUC_RUNTIME_COMPUTED?
in_hot_standby, data_directory_mode
Since GUC_DISALLOW_IN_FILE effectively implies GUC_NOT_IN_SAMPLE in
src/backend/utils/misc/help_config.c:displayStruct(), many of the redundant
GUC_NOT_IN_SAMPLE could be removed.
I think several things with COMPAT_OPTIONS_PREVIOUS could have
GUC_NO_SHOW_ALL and/or GUC_NOT_IN_SAMPLE.
The GUC descriptions are a hodge podge of full sentences and telegrams.
There's no consistency whether the long description can be read independently
from the short description. For these GUCs, the short description reads more
like a "DETAIL" message:
|trace_recovery_messages, log_min_error_statement, log_min_messages,
client_min_messages
|log_transaction_sample_rate, log_statement_sample_rate
|data_directory_mode, log_file_mode, unix_socket_permissions
|log_directory, log_destination, log_line_prefix
|unix_socket_group, default_tablespace, DateStyle, maintenance_work_mem,
geqo_generations
For integer/real GUCs, the long description is being used just to describe the
"special" values:
|jit_inline_above_cost, jit_optimize_above_cost, jit_above_cost,
log_startup_progress_interval,
|tcp_user_timeout, tcp_keepalives_interval, tcp_keepalives_idle,
log_temp_files, old_snapshot_threshold,
|log_parameter_max_length_on_error, log_parameter_max_length,
log_autovacuum_min_duration, log_min_duration_sample,
|idle_session_timeout, idle_in_transaction_session_timeout, lock_timeout,
|statement_timeout, shared_memory_size_in_huge_pages
Descriptions of some GUCs describe their default units, but other's don't.
The units are not very important for input, since a non-default unit can be
specified, like SET statement_timeout='1h'. It's important for output, and
SHOW already includes a unit, which may not be the default unit. So I think
the default units should be removed from the descriptions.
This cleanup is similar to GUC categories fixed in a55a98477.
Tom was of the impression that there's more loose ends on that thread.
https://www.postgresql.org/message-id/flat/16997-ff16127f6e0d1...@postgresql.org
--
Justin
>From b52bbf317126dbd75a2f8e98ceec4f3beb66f572 Mon Sep 17 00:00:00 2001
From: Justin Pryzby <pryz...@telsasoft.com>
Date: Sun, 28 Nov 2021 12:08:48 -0600
Subject: [PATCH 01/10] guc.c: fix GUC flags
---
src/backend/utils/misc/guc.c | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
index e91d5a3cfd..a37ac8a287 100644
--- a/src/backend/utils/misc/guc.c
+++ b/src/backend/utils/misc/guc.c
@@ -1034,7 +1034,8 @@ static struct config_bool ConfigureNamesBool[] =
{
{"enable_incremental_sort", PGC_USERSET, QUERY_TUNING_METHOD,
gettext_noop("Enables the planner's use of incremental sort steps."),
- NULL
+ NULL,
+ GUC_EXPLAIN
},
&enable_incremental_sort,
true,
@@ -3039,7 +3040,8 @@ static struct config_int ConfigureNamesInt[] =
{
{"bgwriter_lru_maxpages", PGC_SIGHUP, RESOURCES_BGWRITER,
gettext_noop("Background writer maximum number of LRU pages to flush per round."),
- NULL
+ NULL,
+ GUC_UNIT_BLOCKS
},
&bgwriter_lru_maxpages,
100, 0, INT_MAX / 2, /* Same upper limit as shared_buffers */
@@ -3188,7 +3190,7 @@ static struct config_int ConfigureNamesInt[] =
{"max_identifier_length", PGC_INTERNAL, PRESET_OPTIONS,
gettext_noop("Shows the maximum identifier length."),
NULL,
- GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
+ GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_UNIT_BYTE
},
&max_identifier_length,
NAMEDATALEN - 1, NAMEDATALEN - 1, NAMEDATALEN - 1,
@@ -3199,7 +3201,7 @@ static struct config_int ConfigureNamesInt[] =
{"block_size", PGC_INTERNAL, PRESET_OPTIONS,
gettext_noop("Shows the size of a disk block."),
NULL,
- GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
+ GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_UNIT_BYTE
},
&block_size,
BLCKSZ, BLCKSZ, BLCKSZ,
@@ -3221,7 +3223,7 @@ static struct config_int ConfigureNamesInt[] =
{"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
gettext_noop("Shows the block size in the write ahead log."),
NULL,
- GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE
+ GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_UNIT_BYTE
},
&wal_block_size,
XLOG_BLCKSZ, XLOG_BLCKSZ, XLOG_BLCKSZ,
@@ -3298,10 +3300,7 @@ static struct config_int ConfigureNamesInt[] =
},
&autovacuum_freeze_max_age,
- /*
- * see pg_resetwal and vacuum_failsafe_age if you change the
- * upper-limit value.
- */
+ /* see vacuum_failsafe_age if you change the upper-limit value. */
200000000, 100000, 2000000000,
NULL, NULL, NULL
},
@@ -3403,7 +3402,7 @@ static struct config_int ConfigureNamesInt[] =
},
{
- {"ssl_renegotiation_limit", PGC_USERSET, CONN_AUTH_SSL,
+ {"ssl_renegotiation_limit", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
gettext_noop("SSL renegotiation is no longer supported; this can only be 0."),
NULL,
GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE,
@@ -4837,7 +4836,8 @@ static struct config_enum ConfigureNamesEnum[] =
{"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
gettext_noop("Enables logging of recovery-related debugging information."),
gettext_noop("Each level includes all the levels that follow it. The later"
- " the level, the fewer messages are sent.")
+ " the level, the fewer messages are sent."),
+ GUC_NOT_IN_SAMPLE,
},
&trace_recovery_messages,
--
2.17.0
>From c1a322618816167dfc82b5dff676c16d60963a9f Mon Sep 17 00:00:00 2001
From: Justin Pryzby <pryz...@telsasoft.com>
Date: Sun, 28 Nov 2021 01:35:04 -0600
Subject: [PATCH 02/10] guc.c: fix GUC descriptions
---
src/backend/utils/misc/guc.c | 105 +++++++++++++++++------------------
1 file changed, 51 insertions(+), 54 deletions(-)
diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
index a37ac8a287..3abd370f9f 100644
--- a/src/backend/utils/misc/guc.c
+++ b/src/backend/utils/misc/guc.c
@@ -1224,7 +1224,7 @@ static struct config_bool ConfigureNamesBool[] =
},
{
{"ssl_passphrase_command_supports_reload", PGC_SIGHUP, CONN_AUTH_SSL,
- gettext_noop("Also use ssl_passphrase_command during server reload."),
+ gettext_noop("Controls whether ssl_passphrase_command is used during server reload."),
NULL
},
&ssl_passphrase_command_supports_reload,
@@ -1244,7 +1244,7 @@ static struct config_bool ConfigureNamesBool[] =
{"fsync", PGC_SIGHUP, WAL_SETTINGS,
gettext_noop("Forces synchronization of updates to disk."),
gettext_noop("The server will use the fsync() system call in several places to make "
- "sure that updates are physically written to disk. This insures "
+ "sure that updates are physically written to disk. This ensures "
"that a database cluster will recover to a consistent state after "
"an operating system or hardware crash.")
},
@@ -1283,9 +1283,9 @@ static struct config_bool ConfigureNamesBool[] =
},
{
{"ignore_invalid_pages", PGC_POSTMASTER, DEVELOPER_OPTIONS,
- gettext_noop("Continues recovery after an invalid pages failure."),
- gettext_noop("Detection of WAL records having references to "
- "invalid pages during recovery causes PostgreSQL to "
+ gettext_noop("Continues recovery after an invalid page failure."),
+ gettext_noop("Detection of WAL records which reference "
+ "an invalid page during recovery normally causes PostgreSQL to "
"raise a PANIC-level error, aborting the recovery. "
"Setting ignore_invalid_pages to true causes "
"the system to ignore invalid page references "
@@ -1304,10 +1304,10 @@ static struct config_bool ConfigureNamesBool[] =
{"full_page_writes", PGC_SIGHUP, WAL_SETTINGS,
gettext_noop("Writes full pages to WAL when first modified after a checkpoint."),
gettext_noop("A page write in process during an operating system crash might be "
- "only partially written to disk. During recovery, the row changes "
- "stored in WAL are not enough to recover. This option writes "
- "pages when first modified after a checkpoint to WAL so full recovery "
- "is possible.")
+ "only partially written to disk. Storing individual row changes "
+ "to WAL is not enough to allow recovery. To guarantee successful recovery, "
+ "this option writes entire pages to WAL following their first modification after each"
+ "checkpoint.")
},
&fullPageWrites,
true,
@@ -1364,7 +1364,7 @@ static struct config_bool ConfigureNamesBool[] =
},
{
{"log_disconnections", PGC_SU_BACKEND, LOGGING_WHAT,
- gettext_noop("Logs end of a session, including duration."),
+ gettext_noop("Logs end of sessions, including duration."),
NULL
},
&Log_disconnections,
@@ -1521,7 +1521,7 @@ static struct config_bool ConfigureNamesBool[] =
{
{"track_activities", PGC_SUSET, STATS_COLLECTOR,
gettext_noop("Collects information about executing commands."),
- gettext_noop("Enables the collection of information on the currently "
+ gettext_noop("Enables the collection of information about the currently "
"executing command of each session, along with "
"the time at which that command began execution.")
},
@@ -1747,7 +1747,7 @@ static struct config_bool ConfigureNamesBool[] =
{
{"array_nulls", PGC_USERSET, COMPAT_OPTIONS_PREVIOUS,
gettext_noop("Enable input of NULL elements in arrays."),
- gettext_noop("When turned on, unquoted NULL in an array input "
+ gettext_noop("When turned on, an unquoted NULL in an array input "
"value means a null value; "
"otherwise it is taken literally.")
},
@@ -1940,7 +1940,7 @@ static struct config_bool ConfigureNamesBool[] =
{
{"allow_system_table_mods", PGC_SUSET, DEVELOPER_OPTIONS,
- gettext_noop("Allows modifications of the structure of system tables."),
+ gettext_noop("Allows modifications to the structure of system tables."),
NULL,
GUC_NOT_IN_SAMPLE
},
@@ -2391,8 +2391,8 @@ static struct config_int ConfigureNamesInt[] =
"permission set. The parameter value is expected "
"to be a numeric mode specification in the form "
"accepted by the chmod and umask system calls. "
- "(To use the customary octal format the number must "
- "start with a 0 (zero).)")
+ "To use the customary octal format, the number must "
+ "start with a 0 (zero).")
},
&Unix_socket_permissions,
0777, 0000, 0777,
@@ -2405,8 +2405,8 @@ static struct config_int ConfigureNamesInt[] =
gettext_noop("The parameter value is expected "
"to be a numeric mode specification in the form "
"accepted by the chmod and umask system calls. "
- "(To use the customary octal format the number must "
- "start with a 0 (zero).)")
+ "To use the customary octal format, the number must "
+ "start with a 0 (zero).")
},
&Log_file_mode,
0600, 0000, 0777,
@@ -2417,10 +2417,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"data_directory_mode", PGC_INTERNAL, PRESET_OPTIONS,
gettext_noop("Shows the mode of the data directory."),
- gettext_noop("The parameter value is a numeric mode specification "
- "in the form accepted by the chmod and umask system "
- "calls. (To use the customary octal format the number "
- "must start with a 0 (zero).)"),
+ gettext_noop("The parameter value is shown in the customary octal format."),
GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_RUNTIME_COMPUTED
},
&data_directory_mode,
@@ -2482,7 +2479,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"temp_file_limit", PGC_SUSET, RESOURCES_DISK,
- gettext_noop("Limits the total size of all temporary files used by each process."),
+ gettext_noop("Limits the total size of all temporary files used by each server process."),
gettext_noop("-1 means no limit."),
GUC_UNIT_KB
},
@@ -2729,7 +2726,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"max_pred_locks_per_relation", PGC_SIGHUP, LOCK_MANAGEMENT,
gettext_noop("Sets the maximum number of predicate-locked pages and tuples per relation."),
- gettext_noop("If more than this total of pages and tuples in the same relation are locked "
+ gettext_noop("If more than this total number of pages and tuples in the same relation are locked "
"by a connection, those locks are replaced by a relation-level lock.")
},
&max_predicate_locks_per_relation,
@@ -2784,8 +2781,8 @@ static struct config_int ConfigureNamesInt[] =
{
{"min_wal_size", PGC_SIGHUP, WAL_CHECKPOINTS,
- gettext_noop("Sets the minimum size to shrink the WAL to."),
- NULL,
+ gettext_noop("Sets the minimum size of the WAL."),
+ gettext_noop("The WAL will not shrink below this size."),
GUC_UNIT_MB
},
&min_wal_size_mb,
@@ -2819,10 +2816,10 @@ static struct config_int ConfigureNamesInt[] =
{
{"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
- gettext_noop("Enables warnings if checkpoint segments are filled more "
+ gettext_noop("Enables warnings if WAL segments are filled more "
"frequently than this."),
- gettext_noop("Write a message to the server log if checkpoints "
- "caused by the filling of checkpoint segment files happens more "
+ gettext_noop("A message is written to the server log if checkpoints "
+ "caused by the filling of WAL segment files happens more "
"frequently than this number of seconds. Zero turns off the warning."),
GUC_UNIT_S
},
@@ -2844,7 +2841,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"wal_buffers", PGC_POSTMASTER, WAL_SETTINGS,
- gettext_noop("Sets the number of disk-page buffers in shared memory for WAL."),
+ gettext_noop("Sets the number of WAL buffers to keep in shared memory."),
NULL,
GUC_UNIT_XBLOCKS
},
@@ -2945,7 +2942,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"commit_siblings", PGC_USERSET, WAL_SETTINGS,
- gettext_noop("Sets the minimum concurrent open transactions before performing "
+ gettext_noop("Sets the minimum number of concurrent open transactions before performing "
"commit_delay."),
NULL
},
@@ -3199,7 +3196,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"block_size", PGC_INTERNAL, PRESET_OPTIONS,
- gettext_noop("Shows the size of a disk block."),
+ gettext_noop("Shows the size of a disk block in bytes."),
NULL,
GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_UNIT_BYTE
},
@@ -3221,7 +3218,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
- gettext_noop("Shows the block size in the write ahead log."),
+ gettext_noop("Shows the block size of the write ahead log in bytes."),
NULL,
GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_UNIT_BYTE
},
@@ -3450,7 +3447,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"min_parallel_table_scan_size", PGC_USERSET, QUERY_TUNING_COST,
gettext_noop("Sets the minimum amount of table data for a parallel scan."),
- gettext_noop("If the planner estimates that it will read a number of table pages too small to reach this limit, a parallel scan will not be considered."),
+ gettext_noop("If the planner estimates that it will read fewer than this number of table pages, a parallel scan will not be considered."),
GUC_UNIT_BLOCKS | GUC_EXPLAIN,
},
&min_parallel_table_scan_size,
@@ -3461,7 +3458,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"min_parallel_index_scan_size", PGC_USERSET, QUERY_TUNING_COST,
gettext_noop("Sets the minimum amount of index data for a parallel scan."),
- gettext_noop("If the planner estimates that it will read a number of index pages too small to reach this limit, a parallel scan will not be considered."),
+ gettext_noop("If the planner estimates that it will read fewer than this number of index pages, a parallel scan will not be considered."),
GUC_UNIT_BLOCKS | GUC_EXPLAIN,
},
&min_parallel_index_scan_size,
@@ -3561,7 +3558,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"client_connection_check_interval", PGC_USERSET, CONN_AUTH_SETTINGS,
- gettext_noop("Sets the time interval between checks for disconnection while running queries."),
+ gettext_noop("Sets the time interval between checks for client disconnection while running queries."),
NULL,
GUC_UNIT_MS
},
@@ -3822,7 +3819,7 @@ static struct config_real ConfigureNamesReal[] =
{
{"checkpoint_completion_target", PGC_SIGHUP, WAL_CHECKPOINTS,
- gettext_noop("Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval."),
+ gettext_noop("Target fraction of checkpoint interval to spend writing dirty buffers to disk."),
NULL
},
&CheckPointCompletionTarget,
@@ -3842,7 +3839,7 @@ static struct config_real ConfigureNamesReal[] =
{
{"log_transaction_sample_rate", PGC_SUSET, LOGGING_WHEN,
- gettext_noop("Sets the fraction of transactions from which to log all statements."),
+ gettext_noop("Sets the fraction of transactions for which all statements are logged."),
gettext_noop("Use a value between 0.0 (never log) and 1.0 (log all "
"statements for all transactions).")
},
@@ -4043,7 +4040,7 @@ static struct config_string ConfigureNamesString[] =
{
{"default_tablespace", PGC_USERSET, CLIENT_CONN_STATEMENT,
- gettext_noop("Sets the default tablespace to create tables and indexes in."),
+ gettext_noop("Sets the default tablespace where tables and indexes are created."),
gettext_noop("An empty string selects the database's default tablespace."),
GUC_IS_NAME
},
@@ -4662,8 +4659,8 @@ static struct config_enum ConfigureNamesEnum[] =
{
{"client_min_messages", PGC_USERSET, CLIENT_CONN_STATEMENT,
gettext_noop("Sets the message levels that are sent to the client."),
- gettext_noop("Each level includes all the levels that follow it. The later"
- " the level, the fewer messages are sent.")
+ gettext_noop("Each level includes all the levels that follow it. Later"
+ " levels send fewer messages.")
},
&client_min_messages,
NOTICE, client_message_level_options,
@@ -4672,7 +4669,7 @@ static struct config_enum ConfigureNamesEnum[] =
{
{"compute_query_id", PGC_SUSET, STATS_MONITORING,
- gettext_noop("Compute query identifiers."),
+ gettext_noop("Enables in-core computation of a query identifier."),
NULL
},
&compute_query_id,
@@ -4682,9 +4679,9 @@ static struct config_enum ConfigureNamesEnum[] =
{
{"constraint_exclusion", PGC_USERSET, QUERY_TUNING_OTHER,
- gettext_noop("Enables the planner to use constraints to optimize queries."),
- gettext_noop("Table scans will be skipped if their constraints"
- " guarantee that no rows match the query."),
+ gettext_noop("Enables the planner's use of constraints to optimize queries."),
+ gettext_noop("Allows a table's scan to be skipped if its constraints"
+ " guarantee that none of its rows match the query."),
GUC_EXPLAIN
},
&constraint_exclusion,
@@ -4748,8 +4745,8 @@ static struct config_enum ConfigureNamesEnum[] =
{
{"log_min_messages", PGC_SUSET, LOGGING_WHEN,
gettext_noop("Sets the message levels that are logged."),
- gettext_noop("Each level includes all the levels that follow it. The later"
- " the level, the fewer messages are sent.")
+ gettext_noop("Each level includes all the levels that follow it. Later"
+ " levels log fewer messages.")
},
&log_min_messages,
WARNING, server_message_level_options,
@@ -4758,9 +4755,9 @@ static struct config_enum ConfigureNamesEnum[] =
{
{"log_min_error_statement", PGC_SUSET, LOGGING_WHEN,
- gettext_noop("Causes all statements generating error at or above this level to be logged."),
- gettext_noop("Each level includes all the levels that follow it. The later"
- " the level, the fewer messages are sent.")
+ gettext_noop("Causes statements generating messages at or above this level to be logged."),
+ gettext_noop("Each level includes all the levels that follow it. Later"
+ " levels log fewer messages.")
},
&log_min_error_statement,
ERROR, server_message_level_options,
@@ -4835,8 +4832,8 @@ static struct config_enum ConfigureNamesEnum[] =
{
{"trace_recovery_messages", PGC_SIGHUP, DEVELOPER_OPTIONS,
gettext_noop("Enables logging of recovery-related debugging information."),
- gettext_noop("Each level includes all the levels that follow it. The later"
- " the level, the fewer messages are sent."),
+ gettext_noop("Each level includes all the levels that follow it. Later"
+ " levels log fewer messages."),
GUC_NOT_IN_SAMPLE,
},
&trace_recovery_messages,
@@ -4932,7 +4929,7 @@ static struct config_enum ConfigureNamesEnum[] =
{
{"huge_pages", PGC_POSTMASTER, RESOURCES_MEM,
- gettext_noop("Use of huge pages on Linux or Windows."),
+ gettext_noop("Enable use of huge pages on Linux or Windows."),
NULL
},
&huge_pages,
@@ -4943,7 +4940,7 @@ static struct config_enum ConfigureNamesEnum[] =
{
{"force_parallel_mode", PGC_USERSET, DEVELOPER_OPTIONS,
gettext_noop("Forces use of parallel query facilities."),
- gettext_noop("If possible, run query using a parallel worker and with parallel restrictions."),
+ gettext_noop("If possible, run queries using a parallel worker and with parallel restrictions."),
GUC_NOT_IN_SAMPLE | GUC_EXPLAIN
},
&force_parallel_mode,
@@ -4963,7 +4960,7 @@ static struct config_enum ConfigureNamesEnum[] =
{
{"plan_cache_mode", PGC_USERSET, QUERY_TUNING_OTHER,
- gettext_noop("Controls the planner's selection of custom or generic plan."),
+ gettext_noop("Controls the planner's selection of custom or generic plans."),
gettext_noop("Prepared statements can have custom and generic plans, and the planner "
"will attempt to choose which is better. This can be set to override "
"the default behavior."),
--
2.17.0
>From 69bb61786295891ebbf918384aefea977215d869 Mon Sep 17 00:00:00 2001
From: Justin Pryzby <pryz...@telsasoft.com>
Date: Sun, 28 Nov 2021 18:52:58 -0600
Subject: [PATCH 03/10] guc.c: do not mention units..
Since values can be specified in other units. The specified units are the
default when no unit is specified.
Note that PRESET options are an exception: they're used for output only,
so the description *should* include units...
---
src/backend/utils/misc/guc.c | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
index 3abd370f9f..96abcfaf90 100644
--- a/src/backend/utils/misc/guc.c
+++ b/src/backend/utils/misc/guc.c
@@ -2132,7 +2132,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"archive_timeout", PGC_SIGHUP, WAL_ARCHIVING,
gettext_noop("Forces a switch to the next WAL file if a "
- "new file has not been started within N seconds."),
+ "new file has not been started within this period of time."),
NULL,
GUC_UNIT_S
},
@@ -2142,7 +2142,7 @@ static struct config_int ConfigureNamesInt[] =
},
{
{"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
- gettext_noop("Waits N seconds on connection startup after authentication."),
+ gettext_noop("Waits this period of time on connection startup after authentication."),
gettext_noop("This allows attaching a debugger to the process."),
GUC_NOT_IN_SAMPLE | GUC_UNIT_S
},
@@ -2468,7 +2468,7 @@ static struct config_int ConfigureNamesInt[] =
*/
{
{"max_stack_depth", PGC_SUSET, RESOURCES_MEM,
- gettext_noop("Sets the maximum stack depth, in kilobytes."),
+ gettext_noop("Sets the maximum stack depth."),
NULL,
GUC_UNIT_KB
},
@@ -2759,7 +2759,7 @@ static struct config_int ConfigureNamesInt[] =
{
/* Not for general use */
{"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
- gettext_noop("Waits N seconds on connection startup before authentication."),
+ gettext_noop("Waits this period of time on connection startup before authentication."),
gettext_noop("This allows attaching a debugger to the process."),
GUC_NOT_IN_SAMPLE | GUC_UNIT_S
},
@@ -3003,7 +3003,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"log_parameter_max_length", PGC_SUSET, LOGGING_WHAT,
- gettext_noop("When logging statements, limit logged parameter values to first N bytes."),
+ gettext_noop("When logging statements, limit logged parameter values to this length."),
gettext_noop("-1 to print values in full."),
GUC_UNIT_BYTE
},
@@ -3014,7 +3014,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"log_parameter_max_length_on_error", PGC_USERSET, LOGGING_WHAT,
- gettext_noop("When reporting an error, limit logged parameter values to first N bytes."),
+ gettext_noop("When reporting an error, limit logged parameter values to this length."),
gettext_noop("-1 to print values in full."),
GUC_UNIT_BYTE
},
@@ -3141,7 +3141,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
- gettext_noop("Automatic log file rotation will occur after N minutes."),
+ gettext_noop("Automatic log file rotation will occur after this period of time."),
NULL,
GUC_UNIT_MIN
},
@@ -3152,7 +3152,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
- gettext_noop("Automatic log file rotation will occur after N kilobytes."),
+ gettext_noop("Automatic log file rotation will occur when the log exceeds this size."),
NULL,
GUC_UNIT_KB
},
@@ -3196,7 +3196,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"block_size", PGC_INTERNAL, PRESET_OPTIONS,
- gettext_noop("Shows the size of a disk block in bytes."),
+ gettext_noop("Shows the size of a disk block."),
NULL,
GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_UNIT_BYTE
},
@@ -3218,7 +3218,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"wal_block_size", PGC_INTERNAL, PRESET_OPTIONS,
- gettext_noop("Shows the block size of the write ahead log in bytes."),
+ gettext_noop("Shows the block size of the write ahead log."),
NULL,
GUC_NOT_IN_SAMPLE | GUC_DISALLOW_IN_FILE | GUC_UNIT_BYTE
},
@@ -3480,7 +3480,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"log_temp_files", PGC_SUSET, LOGGING_WHAT,
- gettext_noop("Log the use of temporary files larger than this number of kilobytes."),
+ gettext_noop("Log the use of temporary files larger than this size."),
gettext_noop("Zero logs all files. The default is -1 (turning this feature off)."),
GUC_UNIT_KB
},
@@ -3491,7 +3491,7 @@ static struct config_int ConfigureNamesInt[] =
{
{"track_activity_query_size", PGC_POSTMASTER, STATS_COLLECTOR,
- gettext_noop("Sets the size reserved for pg_stat_activity.query, in bytes."),
+ gettext_noop("Sets the size reserved for pg_stat_activity.query."),
NULL,
GUC_UNIT_BYTE
},
@@ -3767,7 +3767,7 @@ static struct config_real ConfigureNamesReal[] =
{
{"vacuum_cost_delay", PGC_USERSET, RESOURCES_VACUUM_DELAY,
- gettext_noop("Vacuum cost delay in milliseconds."),
+ gettext_noop("Vacuum cost delay."),
NULL,
GUC_UNIT_MS
},
@@ -3778,7 +3778,7 @@ static struct config_real ConfigureNamesReal[] =
{
{"autovacuum_vacuum_cost_delay", PGC_SIGHUP, AUTOVACUUM,
- gettext_noop("Vacuum cost delay in milliseconds, for autovacuum."),
+ gettext_noop("Vacuum cost delay, for autovacuum."),
NULL,
GUC_UNIT_MS
},
--
2.17.0
