Adjust auto_explain's GUC descriptions.
authorNathan Bossart <[email protected]>
Fri, 28 Feb 2025 22:05:51 +0000 (16:05 -0600)
committerNathan Bossart <[email protected]>
Fri, 28 Feb 2025 22:05:51 +0000 (16:05 -0600)
This commit adjusts auto_explain's GUC descriptions to follow the
style guidelines established by commit 977d865c36.  Specifically,
it ensures the accepted special values are listed in a consistent
manner.

Author: Ilia Evdokimov <[email protected]>
Reviewed-by: Peter Smith <[email protected]>
Discussion: https://postgr.es/m/e82d4647-ce7f-45c7-9b01-fb900a050767%40tantorlabs.com

contrib/auto_explain/auto_explain.c

index 8d665f1e621f9c6c5217235c7021d3be50831636..7007a226c08ca37251cfdd44164185c13d4cfb37 100644 (file)
@@ -94,7 +94,7 @@ _PG_init(void)
    /* Define custom GUC variables. */
    DefineCustomIntVariable("auto_explain.log_min_duration",
                            "Sets the minimum execution time above which plans will be logged.",
-                           "Zero prints all plans. -1 turns this feature off.",
+                           "-1 disables logging plans. 0 means log all plans.",
                            &auto_explain_log_min_duration,
                            -1,
                            -1, INT_MAX,
@@ -105,8 +105,8 @@ _PG_init(void)
                            NULL);
 
    DefineCustomIntVariable("auto_explain.log_parameter_max_length",
-                           "Sets the maximum length of query parameters to log.",
-                           "Zero logs no query parameters, -1 logs them in full.",
+                           "Sets the maximum length of query parameter values to log.",
+                           "-1 means log values in full.",
                            &auto_explain_log_parameter_max_length,
                            -1,
                            -1, INT_MAX,