mirror/postgresql
2
0
Fork 0
mirror of https://git.postgresql.org/git/postgresql.git synced 2024-12-15 08:20:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve ParseConfigFp comment wrt head/tail

Browse Source 
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.
This commit is contained in:
Stephen Frost 2015-05-09 11:13:37 -04:00
parent 9a0884176f
commit 0cf56f14dd
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/backend/utils/misc/guc-file.l
View File

@ -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