diff options
author | Tom Lane <tgl@sss.pgh.pa.us> | 2020-03-10 17:34:01 -0400 |
---|---|---|
committer | Tom Lane <tgl@sss.pgh.pa.us> | 2020-03-10 17:34:09 -0400 |
commit | c8e8b2f9dfee21fa4ef1ec7da5c10e6ef706df36 (patch) | |
tree | eaec8141ecab7066bd1d205680f311da4bd99370 /src | |
parent | d1e241c22602a5369b54e29b7430553445f6a52b (diff) | |
download | postgresql-c8e8b2f9dfee21fa4ef1ec7da5c10e6ef706df36.tar.gz postgresql-c8e8b2f9dfee21fa4ef1ec7da5c10e6ef706df36.zip |
Marginal comments and docs cleanup.
Fix up some imprecise comments and poor markup from ba79cb5dc. Also try
to convert the documentation of log_min_duration_sample and friends into
passable English.
Diffstat (limited to 'src')
-rw-r--r-- | src/backend/nodes/params.c | 11 | ||||
-rw-r--r-- | src/backend/utils/mb/stringinfo_mb.c | 2 |
2 files changed, 7 insertions, 6 deletions
diff --git a/src/backend/nodes/params.c b/src/backend/nodes/params.c index b28ec3b6ce4..a57f9eea768 100644 --- a/src/backend/nodes/params.c +++ b/src/backend/nodes/params.c @@ -262,16 +262,16 @@ RestoreParamList(char **start_address) /* * BuildParamLogString - * Return a string that represent the parameter list, for logging. + * Return a string that represents the parameter list, for logging. * * If caller already knows textual representations for some parameters, it can * pass an array of exactly params->numParams values as knownTextValues, which * can contain NULLs for any unknown individual values. NULL can be given if * no parameters are known. * - * If maxlen is not zero, that's the maximum number of characters of the - * input string printed; an ellipsis is added if more characters exist. - * (Added quotes are not considered.) + * If maxlen is not zero, that's the maximum number of bytes of any one + * parameter value to be printed; an ellipsis is added if the string is + * longer. (Added quotes are not considered in this calculation.) */ char * BuildParamLogString(ParamListInfo params, char **knownTextValues, int maxlen) @@ -282,7 +282,8 @@ BuildParamLogString(ParamListInfo params, char **knownTextValues, int maxlen) /* * NB: think not of returning params->paramValuesStr! It may have been - * generated with a different maxlen, and so unsuitable. + * generated with a different maxlen, and so be unsuitable. Besides that, + * this is the function used to create that string. */ /* diff --git a/src/backend/utils/mb/stringinfo_mb.c b/src/backend/utils/mb/stringinfo_mb.c index c153b770076..791a667daea 100644 --- a/src/backend/utils/mb/stringinfo_mb.c +++ b/src/backend/utils/mb/stringinfo_mb.c @@ -26,7 +26,7 @@ /* * appendStringInfoStringQuoted * - * Append up to maxlen characters from s to str, or the whole input string if + * Append up to maxlen bytes from s to str, or the whole input string if * maxlen <= 0, adding single quotes around it and doubling all single quotes. * Add an ellipsis if the copy is incomplete. */ |