Add missing EmitWarningsOnPlaceholders() calls.

tglsfdc · tglsfdc · commit 1fada5d81e67 · 2021-12-21T12:12:24.000-05:00
Extensions that define any custom GUCs should call EmitWarningsOnPlaceholders after doing so, to help catch misspellings. Many of our contrib modules hadn't gotten the memo on that, though. Also add such calls to src/test/modules extensions that have GUCs. While these aren't really user-facing, they should illustrate good practice not faulty practice. Shinya Kato Discussion: https://postgr.es/m/524fa2c0a34f34b68fbfa90d0760d515@oss.nttdata.com
diff --git a/contrib/auth_delay/auth_delay.c b/contrib/auth_delay/auth_delay.c
@@ -67,6 +67,9 @@ _PG_init(void)
 							NULL,
 							NULL,
 							NULL);
+
+	EmitWarningsOnPlaceholders("auth_delay");
+
 	/* Install Hooks */
 	original_client_auth_hook = ClientAuthentication_hook;
 	ClientAuthentication_hook = auth_delay_checks;
diff --git a/contrib/pg_trgm/trgm_op.c b/contrib/pg_trgm/trgm_op.c
@@ -100,6 +100,8 @@ _PG_init(void)
 							 NULL,
 							 NULL,
 							 NULL);
+
+	EmitWarningsOnPlaceholders("pg_trgm");
 }
 
 /*
diff --git a/contrib/postgres_fdw/option.c b/contrib/postgres_fdw/option.c
@@ -469,4 +469,6 @@ _PG_init(void)
 							   NULL,
 							   NULL,
 							   NULL);
+
+	EmitWarningsOnPlaceholders("postgres_fdw");
 }
diff --git a/contrib/sepgsql/hooks.c b/contrib/sepgsql/hooks.c
@@ -455,6 +455,8 @@ _PG_init(void)
 							 NULL,
 							 NULL);
 
+	EmitWarningsOnPlaceholders("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
@@ -9194,6 +9194,9 @@ reapply_stacked_values(struct config_generic *variable,
 	}
 }
 
+/*
+ * Functions for extensions to call to define their custom GUC variables.
+ */
 void
 DefineCustomBoolVariable(const char *name,
 						 const char *short_desc,
@@ -9333,6 +9336,10 @@ DefineCustomEnumVariable(const char *name,
 	define_custom_variable(&var->gen);
 }
 
+/*
+ * Extensions should call this after they've defined all of their custom
+ * GUCs, to help catch misspelled config-file entries,
+ */
 void
 EmitWarningsOnPlaceholders(const char *className)
 {
diff --git a/src/pl/tcl/pltcl.c b/src/pl/tcl/pltcl.c
@@ -474,6 +474,9 @@ _PG_init(void)
 							   PGC_SUSET, 0,
 							   NULL, NULL, NULL);
 
+	EmitWarningsOnPlaceholders("pltcl");
+	EmitWarningsOnPlaceholders("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,6 +91,8 @@ _PG_init(void)
 							NULL,
 							NULL);
 
+	EmitWarningsOnPlaceholders("delay_execution");
+
 	/* Install our hook */
 	prev_planner_hook = planner_hook;
 	planner_hook = delay_execution_planner;
diff --git a/src/test/modules/ssl_passphrase_callback/ssl_passphrase_func.c b/src/test/modules/ssl_passphrase_callback/ssl_passphrase_func.c
@@ -48,6 +48,9 @@ _PG_init(void)
 							   NULL,
 							   NULL,
 							   NULL);
+
+	EmitWarningsOnPlaceholders("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,6 +322,8 @@ _PG_init(void)
 							   0,
 							   NULL, NULL, NULL);
 
+	EmitWarningsOnPlaceholders("worker_spi");
+
 	/* set up common data for all our workers */
 	memset(&worker, 0, sizeof(worker));
 	worker.bgw_flags = BGWORKER_SHMEM_ACCESS |

Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,8 @@ _PG_init(void)`
`100`	`100`	`NULL,`
`101`	`101`	`NULL,`
`102`	`102`	`NULL);`
	`103`	`+`
	`104`	`+ EmitWarningsOnPlaceholders("pg_trgm");`
`103`	`105`	`}`
`104`	`106`
`105`	`107`	`/*`
Original file line number	Diff line number	Diff line change
`@@ -469,4 +469,6 @@ _PG_init(void)`
`469`	`469`	`NULL,`
`470`	`470`	`NULL,`
`471`	`471`	`NULL);`
	`472`	`+`
	`473`	`+ EmitWarningsOnPlaceholders("postgres_fdw");`
`472`	`474`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9194,6 +9194,9 @@ reapply_stacked_values(struct config_generic *variable,`
`9194`	`9194`	`}`
`9195`	`9195`	`}`
`9196`	`9196`
	`9197`	`+/*`
	`9198`	`+ * Functions for extensions to call to define their custom GUC variables.`
	`9199`	`+ */`
`9197`	`9200`	`void`
`9198`	`9201`	`DefineCustomBoolVariable(const char *name,`
`9199`	`9202`	`const char *short_desc,`
`@@ -9333,6 +9336,10 @@ DefineCustomEnumVariable(const char *name,`
`9333`	`9336`	`define_custom_variable(&var->gen);`
`9334`	`9337`	`}`
`9335`	`9338`
	`9339`	`+/*`
	`9340`	`+ * Extensions should call this after they've defined all of their custom`
	`9341`	`+ * GUCs, to help catch misspelled config-file entries,`
	`9342`	`+ */`
`9336`	`9343`	`void`
`9337`	`9344`	`EmitWarningsOnPlaceholders(const char *className)`
`9338`	`9345`	`{`
Original file line number	Diff line number	Diff line change
`@@ -474,6 +474,9 @@ _PG_init(void)`
`474`	`474`	`PGC_SUSET, 0,`
`475`	`475`	`NULL, NULL, NULL);`
`476`	`476`
	`477`	`+ EmitWarningsOnPlaceholders("pltcl");`
	`478`	`+ EmitWarningsOnPlaceholders("pltclu");`
	`479`	`+`
`477`	`480`	`pltcl_pm_init_done = true;`
`478`	`481`	`}`
`479`	`482`