diff options
| author | Stephen Frost <sfrost@snowman.net> | 2015-05-09 11:13:37 -0400 |
|---|---|---|
| committer | Stephen Frost <sfrost@snowman.net> | 2015-05-09 11:13:37 -0400 |
| commit | 0cf56f14dd15532fec930b502cb6457023b01ef8 (patch) | |
| tree | cf9afd87e421681fc05f11377f6132d82c2f1aa9 /src | |
| parent | 9a0884176fdfa51551d6a3b26fa0e1b216c3e4c2 (diff) | |
| download | postgresql-0cf56f14dd15532fec930b502cb6457023b01ef8.tar.gz postgresql-0cf56f14dd15532fec930b502cb6457023b01ef8.zip | |
Improve ParseConfigFp comment wrt head/tail
The head_p and tail_p pointers passed to ParseConfigFp() are actually
input/output parameters, not strictly output paramaters. This updates
the function comment to reflect that.
Per discussion with Tom.
Diffstat (limited to 'src')
| -rw-r--r-- | src/backend/utils/misc/guc-file.l | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/backend/utils/misc/guc-file.l b/src/backend/utils/misc/guc-file.l index a04d35d3c98..5c0a9655fd8 100644 --- a/src/backend/utils/misc/guc-file.l +++ b/src/backend/utils/misc/guc-file.l @@ -604,12 +604,12 @@ GUC_flex_fatal(const char *msg) * config_file: absolute or relative path name of the configuration file * depth: recursion depth (should be 0 in the outermost call) * elevel: error logging level to use - * Output parameters: + * Input/Output parameters: * head_p, tail_p: head and tail of linked list of name/value pairs * - * *head_p and *tail_p must be initialized to NULL before calling the outer - * recursion level. On exit, they contain a list of name-value pairs read - * from the input file(s). + * *head_p and *tail_p must either be initialized to NULL or valid pointers + * to a ConfigVariable list before calling the outer recursion level. Any + * name-value pairs read from the input file(s) will be added to the list. * * Returns TRUE if successful, FALSE if an error occurred. The error has * already been ereport'd, it is only necessary for the caller to clean up |