Rename EmitWarningsOnPlaceholders() to MarkGUCPrefixReserved().

tglsfdc · tglsfdc · commit 5609cc01c69b · 2021-12-27T14:39:08.000-05:00
This seems like a clearer name for what it does now. Provide a compatibility macro so that extensions don't have to convert to the new name right away. Discussion: https://postgr.es/m/116024.1640111629@sss.pgh.pa.us
diff --git a/contrib/auth_delay/auth_delay.c b/contrib/auth_delay/auth_delay.c
@@ -68,7 +68,7 @@ _PG_init(void)
 							NULL,
 							NULL);
 
-	EmitWarningsOnPlaceholders("auth_delay");
+	MarkGUCPrefixReserved("auth_delay");
 
 	/* Install Hooks */
 	original_client_auth_hook = ClientAuthentication_hook;
diff --git a/contrib/auto_explain/auto_explain.c b/contrib/auto_explain/auto_explain.c
@@ -231,7 +231,7 @@ _PG_init(void)
 							 NULL,
 							 NULL);
 
-	EmitWarningsOnPlaceholders("auto_explain");
+	MarkGUCPrefixReserved("auto_explain");
 
 	/* Install hooks. */
 	prev_ExecutorStart = ExecutorStart_hook;
diff --git a/contrib/pg_prewarm/autoprewarm.c b/contrib/pg_prewarm/autoprewarm.c
@@ -136,7 +136,7 @@ _PG_init(void)
 							 NULL,
 							 NULL);
 
-	EmitWarningsOnPlaceholders("pg_prewarm");
+	MarkGUCPrefixReserved("pg_prewarm");
 
 	RequestAddinShmemSpace(MAXALIGN(sizeof(AutoPrewarmSharedState)));
 
diff --git a/contrib/pg_stat_statements/pg_stat_statements.c b/contrib/pg_stat_statements/pg_stat_statements.c
@@ -437,7 +437,7 @@ _PG_init(void)
 							 NULL,
 							 NULL);
 
-	EmitWarningsOnPlaceholders("pg_stat_statements");
+	MarkGUCPrefixReserved("pg_stat_statements");
 
 	/*
 	 * Request additional shared resources.  (These are no-ops if we're not in
diff --git a/contrib/pg_trgm/trgm_op.c b/contrib/pg_trgm/trgm_op.c
@@ -101,7 +101,7 @@ _PG_init(void)
 							 NULL,
 							 NULL);
 
-	EmitWarningsOnPlaceholders("pg_trgm");
+	MarkGUCPrefixReserved("pg_trgm");
 }
 
 /*
diff --git a/contrib/postgres_fdw/option.c b/contrib/postgres_fdw/option.c
@@ -532,5 +532,5 @@ _PG_init(void)
 							   NULL,
 							   NULL);
 
-	EmitWarningsOnPlaceholders("postgres_fdw");
+	MarkGUCPrefixReserved("postgres_fdw");
 }
diff --git a/contrib/sepgsql/hooks.c b/contrib/sepgsql/hooks.c
@@ -455,7 +455,7 @@ _PG_init(void)
 							 NULL,
 							 NULL);
 
-	EmitWarningsOnPlaceholders("sepgsql");
+	MarkGUCPrefixReserved("sepgsql");
 
 	/* Initialize userspace access vector cache */
 	sepgsql_avc_init();
diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
@@ -9360,11 +9360,15 @@ DefineCustomEnumVariable(const char *name,
 }
 
 /*
+ * Mark the given GUC prefix as "reserved".
+ *
+ * This prints warnings if there are any existing placeholders matching
+ * the prefix, and then prevents new ones from being created.
  * Extensions should call this after they've defined all of their custom
- * GUCs, to help catch misspelled config-file entries,
+ * GUCs, to help catch misspelled config-file entries.
  */
 void
-EmitWarningsOnPlaceholders(const char *className)
+MarkGUCPrefixReserved(const char *className)
 {
 	int			classLen = strlen(className);
 	int			i;
diff --git a/src/include/utils/guc.h b/src/include/utils/guc.h
@@ -354,7 +354,10 @@ extern void DefineCustomEnumVariable(const char *name,
 									 GucEnumAssignHook assign_hook,
 									 GucShowHook show_hook);
 
-extern void EmitWarningsOnPlaceholders(const char *className);
+extern void MarkGUCPrefixReserved(const char *className);
+
+/* old name for MarkGUCPrefixReserved, for backwards compatibility: */
+#define EmitWarningsOnPlaceholders(className) MarkGUCPrefixReserved(className)
 
 extern const char *GetConfigOption(const char *name, bool missing_ok,
 								   bool restrict_privileged);
diff --git a/src/pl/plperl/plperl.c b/src/pl/plperl/plperl.c
@@ -453,7 +453,7 @@ _PG_init(void)
 							   PGC_SUSET, 0,
 							   NULL, NULL, NULL);
 
-	EmitWarningsOnPlaceholders("plperl");
+	MarkGUCPrefixReserved("plperl");
 
 	/*
 	 * Create hash tables.
diff --git a/src/pl/plpgsql/src/pl_handler.c b/src/pl/plpgsql/src/pl_handler.c
@@ -197,7 +197,7 @@ _PG_init(void)
 							   plpgsql_extra_errors_assign_hook,
 							   NULL);
 
-	EmitWarningsOnPlaceholders("plpgsql");
+	MarkGUCPrefixReserved("plpgsql");
 
 	plpgsql_HashTableInit();
 	RegisterXactCallback(plpgsql_xact_cb, NULL);
diff --git a/src/pl/tcl/pltcl.c b/src/pl/tcl/pltcl.c
@@ -474,8 +474,8 @@ _PG_init(void)
 							   PGC_SUSET, 0,
 							   NULL, NULL, NULL);
 
-	EmitWarningsOnPlaceholders("pltcl");
-	EmitWarningsOnPlaceholders("pltclu");
+	MarkGUCPrefixReserved("pltcl");
+	MarkGUCPrefixReserved("pltclu");
 
 	pltcl_pm_init_done = true;
 }
diff --git a/src/test/modules/delay_execution/delay_execution.c b/src/test/modules/delay_execution/delay_execution.c
@@ -91,7 +91,7 @@ _PG_init(void)
 							NULL,
 							NULL);
 
-	EmitWarningsOnPlaceholders("delay_execution");
+	MarkGUCPrefixReserved("delay_execution");
 
 	/* Install our hook */
 	prev_planner_hook = planner_hook;
diff --git a/src/test/modules/ssl_passphrase_callback/ssl_passphrase_func.c b/src/test/modules/ssl_passphrase_callback/ssl_passphrase_func.c
@@ -49,7 +49,7 @@ _PG_init(void)
 							   NULL,
 							   NULL);
 
-	EmitWarningsOnPlaceholders("ssl_passphrase");
+	MarkGUCPrefixReserved("ssl_passphrase");
 
 	if (ssl_passphrase)
 		openssl_tls_init_hook = set_rot13;
diff --git a/src/test/modules/worker_spi/worker_spi.c b/src/test/modules/worker_spi/worker_spi.c
@@ -322,7 +322,7 @@ _PG_init(void)
 							   0,
 							   NULL, NULL, NULL);
 
-	EmitWarningsOnPlaceholders("worker_spi");
+	MarkGUCPrefixReserved("worker_spi");
 
 	/* set up common data for all our workers */
 	memset(&worker, 0, sizeof(worker));

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ _PG_init(void)`
`101`	`101`	`NULL,`
`102`	`102`	`NULL);`
`103`	`103`
`104`		`- EmitWarningsOnPlaceholders("pg_trgm");`
	`104`	`+ MarkGUCPrefixReserved("pg_trgm");`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`/*`
Original file line number	Diff line number	Diff line change
`@@ -532,5 +532,5 @@ _PG_init(void)`
`532`	`532`	`NULL,`
`533`	`533`	`NULL);`
`534`	`534`
`535`		`- EmitWarningsOnPlaceholders("postgres_fdw");`
	`535`	`+ MarkGUCPrefixReserved("postgres_fdw");`
`536`	`536`	`}`