summaryrefslogtreecommitdiff
path: root/src/include/pg_getopt.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/pg_getopt.h')
-rw-r--r--src/include/pg_getopt.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/include/pg_getopt.h b/src/include/pg_getopt.h
index bb5d234440..639a1613c1 100644
--- a/src/include/pg_getopt.h
+++ b/src/include/pg_getopt.h
@@ -1,4 +1,13 @@
/*
+ * Postgres files that use getopt(3) always include this file.
+ * We must cope with three different scenarios:
+ * 1. We're using the platform's getopt(), and we should just import the
+ * appropriate declarations.
+ * 2. The platform lacks getopt(), and we must declare everything.
+ * 3. The platform has getopt(), but we're not using it because we don't
+ * like its behavior. The declarations we make here must be compatible
+ * with both the platform's getopt() and our src/port/getopt.c.
+ *
* Portions Copyright (c) 1987, 1993, 1994
* The Regents of the University of California. All rights reserved.
*
@@ -39,6 +48,7 @@ extern int optopt;
extern int optreset;
#endif
+/* Provide getopt() declaration if the platform doesn't have it */
#ifndef HAVE_GETOPT
extern int getopt(int nargc, char *const *nargv, const char *ostr);
#endif