Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 03774f9

Browse files
committed
Improve the description of various GUCs
This commit fixes a couple of inconsistencies in the descriptions of some GUCs, while making their wording more general regarding the units they rely on. For most of them, this removes the use of terms like "N seconds" or "N bytes", which may not apply easily to all the languages these strings are translated to (from my own experience, this works in French and English, less in Japanese). Per debate between the authors listed below. Author: Justin Pryzby, Michael Paquier Discussion: https://postgr.es/m/20211129030833.GJ17618@telsasoft.com
1 parent 6051857 commit 03774f9

File tree

1 file changed

+19
-12
lines changed
  • src/backend/utils/misc

1 file changed

+19
-12
lines changed

src/backend/utils/misc/guc.c

+19-12
Original file line numberDiff line numberDiff line change
@@ -2133,8 +2133,8 @@ static struct config_int ConfigureNamesInt[] =
21332133
{
21342134
{
21352135
{"archive_timeout", PGC_SIGHUP, WAL_ARCHIVING,
2136-
gettext_noop("Forces a switch to the next WAL file if a "
2137-
"new file has not been started within N seconds."),
2136+
gettext_noop("Sets the amount of time to wait before forcing a "
2137+
"switch to the next WAL file."),
21382138
NULL,
21392139
GUC_UNIT_S
21402140
},
@@ -2144,7 +2144,8 @@ static struct config_int ConfigureNamesInt[] =
21442144
},
21452145
{
21462146
{"post_auth_delay", PGC_BACKEND, DEVELOPER_OPTIONS,
2147-
gettext_noop("Waits N seconds on connection startup after authentication."),
2147+
gettext_noop("Sets the amount of time to wait after "
2148+
"authentication on connection startup."),
21482149
gettext_noop("This allows attaching a debugger to the process."),
21492150
GUC_NOT_IN_SAMPLE | GUC_UNIT_S
21502151
},
@@ -2764,7 +2765,8 @@ static struct config_int ConfigureNamesInt[] =
27642765
{
27652766
/* Not for general use */
27662767
{"pre_auth_delay", PGC_SIGHUP, DEVELOPER_OPTIONS,
2767-
gettext_noop("Waits N seconds on connection startup before authentication."),
2768+
gettext_noop("Sets the amount of time to wait before "
2769+
"authentication on connection startup."),
27682770
gettext_noop("This allows attaching a debugger to the process."),
27692771
GUC_NOT_IN_SAMPLE | GUC_UNIT_S
27702772
},
@@ -2821,11 +2823,12 @@ static struct config_int ConfigureNamesInt[] =
28212823

28222824
{
28232825
{"checkpoint_warning", PGC_SIGHUP, WAL_CHECKPOINTS,
2824-
gettext_noop("Enables warnings if checkpoint segments are filled more "
2825-
"frequently than this."),
2826+
gettext_noop("Sets the maximum time before warning if checkpoints "
2827+
"triggered by WAL volume happen too frequently."),
28262828
gettext_noop("Write a message to the server log if checkpoints "
2827-
"caused by the filling of checkpoint segment files happens more "
2828-
"frequently than this number of seconds. Zero turns off the warning."),
2829+
"caused by the filling of WAL segment files happen more "
2830+
"frequently than this amount of time. "
2831+
"Zero turns off the warning."),
28292832
GUC_UNIT_S
28302833
},
28312834
&CheckPointWarning,
@@ -3008,7 +3011,8 @@ static struct config_int ConfigureNamesInt[] =
30083011

30093012
{
30103013
{"log_parameter_max_length", PGC_SUSET, LOGGING_WHAT,
3011-
gettext_noop("When logging statements, limit logged parameter values to first N bytes."),
3014+
gettext_noop("Sets the maximum length in bytes of data logged for bind "
3015+
"parameter values when logging statements."),
30123016
gettext_noop("-1 to print values in full."),
30133017
GUC_UNIT_BYTE
30143018
},
@@ -3019,7 +3023,8 @@ static struct config_int ConfigureNamesInt[] =
30193023

30203024
{
30213025
{"log_parameter_max_length_on_error", PGC_USERSET, LOGGING_WHAT,
3022-
gettext_noop("When reporting an error, limit logged parameter values to first N bytes."),
3026+
gettext_noop("Sets the maximum length in bytes of data logged for bind "
3027+
"parameter values when logging statements, on error."),
30233028
gettext_noop("-1 to print values in full."),
30243029
GUC_UNIT_BYTE
30253030
},
@@ -3145,7 +3150,8 @@ static struct config_int ConfigureNamesInt[] =
31453150

31463151
{
31473152
{"log_rotation_age", PGC_SIGHUP, LOGGING_WHERE,
3148-
gettext_noop("Automatic log file rotation will occur after N minutes."),
3153+
gettext_noop("Sets the amount of time to wait before forcing "
3154+
"log file rotation."),
31493155
NULL,
31503156
GUC_UNIT_MIN
31513157
},
@@ -3156,7 +3162,8 @@ static struct config_int ConfigureNamesInt[] =
31563162

31573163
{
31583164
{"log_rotation_size", PGC_SIGHUP, LOGGING_WHERE,
3159-
gettext_noop("Automatic log file rotation will occur after N kilobytes."),
3165+
gettext_noop("Sets the maximum size a log file can reach before "
3166+
"being rotated."),
31603167
NULL,
31613168
GUC_UNIT_KB
31623169
},

0 commit comments

Comments
 (0)