Skip to content

Commit 0cf56f1

Browse files
committed
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.
1 parent 9a08841 commit 0cf56f1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/backend/utils/misc/guc-file.l

+4-4
Original file line numberDiff line numberDiff line change
@@ -604,12 +604,12 @@ GUC_flex_fatal(const char *msg)
604604
* config_file: absolute or relative path name of the configuration file
605605
* depth: recursion depth (should be 0 in the outermost call)
606606
* elevel: error logging level to use
607-
* Output parameters:
607+
* Input/Output parameters:
608608
* head_p, tail_p: head and tail of linked list of name/value pairs
609609
*
610-
* *head_p and *tail_p must be initialized to NULL before calling the outer
611-
* recursion level. On exit, they contain a list of name-value pairs read
612-
* from the input file(s).
610+
* *head_p and *tail_p must either be initialized to NULL or valid pointers
611+
* to a ConfigVariable list before calling the outer recursion level. Any
612+
* name-value pairs read from the input file(s) will be added to the list.
613613
*
614614
* Returns TRUE if successful, FALSE if an error occurred. The error has
615615
* already been ereport'd, it is only necessary for the caller to clean up

0 commit comments

Comments
 (0)