Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Rename EmitWarningsOnPlaceholders() to MarkGUCPrefixReserved().
authorTom Lane <tgl@sss.pgh.pa.us>
Mon, 27 Dec 2021 19:39:08 +0000 (14:39 -0500)
committerTom Lane <tgl@sss.pgh.pa.us>
Mon, 27 Dec 2021 19:39:08 +0000 (14:39 -0500)
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

15 files changed:
contrib/auth_delay/auth_delay.c
contrib/auto_explain/auto_explain.c
contrib/pg_prewarm/autoprewarm.c
contrib/pg_stat_statements/pg_stat_statements.c
contrib/pg_trgm/trgm_op.c
contrib/postgres_fdw/option.c
contrib/sepgsql/hooks.c
src/backend/utils/misc/guc.c
src/include/utils/guc.h
src/pl/plperl/plperl.c
src/pl/plpgsql/src/pl_handler.c
src/pl/tcl/pltcl.c
src/test/modules/delay_execution/delay_execution.c
src/test/modules/ssl_passphrase_callback/ssl_passphrase_func.c
src/test/modules/worker_spi/worker_spi.c

index d11dd1e416e1939301aa881e04b49efb0dfc949b..ca1e483d61a269a7b61568fc0a102ac4cd55c052 100644 (file)
@@ -68,7 +68,7 @@ _PG_init(void)
                            NULL,
                            NULL);
 
-   EmitWarningsOnPlaceholders("auth_delay");
+   MarkGUCPrefixReserved("auth_delay");
 
    /* Install Hooks */
    original_client_auth_hook = ClientAuthentication_hook;
index 59ba63455fd18ebf790f334c630d53fde41ee8b8..a695fba0c5768586c8d07d38fdc235adb1c84047 100644 (file)
@@ -231,7 +231,7 @@ _PG_init(void)
                             NULL,
                             NULL);
 
-   EmitWarningsOnPlaceholders("auto_explain");
+   MarkGUCPrefixReserved("auto_explain");
 
    /* Install hooks. */
    prev_ExecutorStart = ExecutorStart_hook;
index 0289ea657cb64dfc3ab74f5e2f43370a00257172..8a2a90ad97b166b6e37e87af62303106d56068c2 100644 (file)
@@ -136,7 +136,7 @@ _PG_init(void)
                             NULL,
                             NULL);
 
-   EmitWarningsOnPlaceholders("pg_prewarm");
+   MarkGUCPrefixReserved("pg_prewarm");
 
    RequestAddinShmemSpace(MAXALIGN(sizeof(AutoPrewarmSharedState)));
 
index 726ba59e2bf48552db1d8d33cef1378750dd71d4..8b2a8bbfe672138b50120602ccc7d1d460850436 100644 (file)
@@ -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
index 0407c7dd64472e955c1f465d9f91730807ecd7d4..e9b7981619fb630e7df636b29f4ea5f3700d47d1 100644 (file)
@@ -101,7 +101,7 @@ _PG_init(void)
                             NULL,
                             NULL);
 
-   EmitWarningsOnPlaceholders("pg_trgm");
+   MarkGUCPrefixReserved("pg_trgm");
 }
 
 /*
index c2c4e36802c9a9bdbaed61fae6d655963c3a69f2..194c81ef35b55b6af37bd7c28c970c9c11795d34 100644 (file)
@@ -532,5 +532,5 @@ _PG_init(void)
                               NULL,
                               NULL);
 
-   EmitWarningsOnPlaceholders("postgres_fdw");
+   MarkGUCPrefixReserved("postgres_fdw");
 }
index 44a09c35a7c999417665a9dc517f9efe94f0916b..c0d977d4fab4894a806d4adfd1da3a9da251067f 100644 (file)
@@ -455,7 +455,7 @@ _PG_init(void)
                             NULL,
                             NULL);
 
-   EmitWarningsOnPlaceholders("sepgsql");
+   MarkGUCPrefixReserved("sepgsql");
 
    /* Initialize userspace access vector cache */
    sepgsql_avc_init();
index f345eceb5b7b5c19ba47f92915bb98fe3e81e811..d239004347963c81b657c1989a78c82140dd9130 100644 (file)
@@ -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;
index aa18d304ac03a7eebbdd1aba1a55495562f0c1a0..5ba95ced2c7f866cc530963fc5a9b19742169681 100644 (file)
@@ -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);
index 1c77211ac45426984a1bba5a3b608ae6df78a3a1..2497315e3b0e2144796c58c96a96b6ffb7848b77 100644 (file)
@@ -453,7 +453,7 @@ _PG_init(void)
                               PGC_SUSET, 0,
                               NULL, NULL, NULL);
 
-   EmitWarningsOnPlaceholders("plperl");
+   MarkGUCPrefixReserved("plperl");
 
    /*
     * Create hash tables.
index 00aace2f39fb32395564b1d995f3d1ff13b3cdd1..55c39d208deb9a07723e71730779221c4088b392 100644 (file)
@@ -197,7 +197,7 @@ _PG_init(void)
                               plpgsql_extra_errors_assign_hook,
                               NULL);
 
-   EmitWarningsOnPlaceholders("plpgsql");
+   MarkGUCPrefixReserved("plpgsql");
 
    plpgsql_HashTableInit();
    RegisterXactCallback(plpgsql_xact_cb, NULL);
index 7c045f4560713af3491e11829cd1c7714649b7fc..ab759833db11128cad4a2d84c849cbaa163bcd38 100644 (file)
@@ -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;
 }
index 8ec623ac52790ebb7fe225eeb671252a4c001895..25722d87ccc2bd1893fc53ca86b790855a44eb7c 100644 (file)
@@ -91,7 +91,7 @@ _PG_init(void)
                            NULL,
                            NULL);
 
-   EmitWarningsOnPlaceholders("delay_execution");
+   MarkGUCPrefixReserved("delay_execution");
 
    /* Install our hook */
    prev_planner_hook = planner_hook;
index 3ba33e501c3c6fedd0b087584525d1af0b6d7b79..7c469fd57e885768429da403b9ecfcf8ed1096ef 100644 (file)
@@ -49,7 +49,7 @@ _PG_init(void)
                               NULL,
                               NULL);
 
-   EmitWarningsOnPlaceholders("ssl_passphrase");
+   MarkGUCPrefixReserved("ssl_passphrase");
 
    if (ssl_passphrase)
        openssl_tls_init_hook = set_rot13;
index adb02d8cb83987b1147680cab060181e507c3189..3e9227aa8ae4162b1aba86f4144020a294f8508c 100644 (file)
@@ -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));