Add unit documentation for various postgresql.conf settings.

diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
index 47cb894e8edfb92649e14f9e25d9578f660cadad..9c5913ac5b6370c8f2db0fc3f2471c32251e97e5 100644 (file)
--- a/src/backend/utils/misc/guc.c
+++ b/src/backend/utils/misc/guc.c
@@ -10,7 +10,7 @@
  * Written by Peter Eisentraut <peter_e@gmx.net>.
  *
  * IDENTIFICATION
- *   $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.499 2009/04/02 19:57:19 momjian Exp $
+ *   $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.500 2009/04/06 21:00:52 momjian Exp $
  *
  *--------------------------------------------------------------------
  */
@@ -1530,7 +1530,7 @@ static struct config_int ConfigureNamesInt[] =
 
    {
        {"statement_timeout", PGC_USERSET, CLIENT_CONN_STATEMENT,
-           gettext_noop("Sets the maximum allowed duration of any statement."),
+           gettext_noop("Sets the maximum duration of any statement, in milliseconds."),
            gettext_noop("A value of 0 turns off the timeout."),
            GUC_UNIT_MS
        },
@@ -1684,7 +1684,7 @@ static struct config_int ConfigureNamesInt[] =
 
    {
        {"log_autovacuum_min_duration", PGC_SIGHUP, LOGGING_WHAT,
-           gettext_noop("Sets the minimum execution time above which "
+           gettext_noop("Sets the minimum execution milliseconds above which "
                         "autovacuum actions will be logged."),
            gettext_noop("Zero prints all actions. -1 turns autovacuum logging off."),
            GUC_UNIT_MS
@@ -1871,7 +1871,7 @@ static struct config_int ConfigureNamesInt[] =
 
    {
        {"tcp_keepalives_idle", PGC_USERSET, CLIENT_CONN_OTHER,
-           gettext_noop("Time between issuing TCP keepalives."),
+           gettext_noop("Seconds between issuing TCP keepalives."),
            gettext_noop("A value of 0 uses the system default."),
            GUC_UNIT_S
        },
@@ -1881,7 +1881,7 @@ static struct config_int ConfigureNamesInt[] =
 
    {
        {"tcp_keepalives_interval", PGC_USERSET, CLIENT_CONN_OTHER,
-           gettext_noop("Time between TCP keepalive retransmits."),
+           gettext_noop("Seconds between TCP keepalive retransmits."),
            gettext_noop("A value of 0 uses the system default."),
            GUC_UNIT_S
        },

diff --git a/src/backend/utils/misc/postgresql.conf.sample b/src/backend/utils/misc/postgresql.conf.sample
index 0c46142f9731597b3b52494ffa7499db18b8c087..cffa1e3d794529b6689684754ed4de75749966e9 100644 (file)
--- a/src/backend/utils/misc/postgresql.conf.sample
+++ b/src/backend/utils/misc/postgresql.conf.sample
@@ -122,7 +122,7 @@
 
 # - Cost-Based Vacuum Delay -
 
-#vacuum_cost_delay = 0         # 0-100 milliseconds
+#vacuum_cost_delay = 0ms       # 0-100 milliseconds
 #vacuum_cost_page_hit = 1      # 0-10000 credits
 #vacuum_cost_page_miss = 10        # 0-10000 credits
 #vacuum_cost_page_dirty = 20       # 0-10000 credits
@@ -175,7 +175,7 @@
                # (change requires restart)
 #archive_command = ''      # command to use to archive a logfile segment
 #archive_timeout = 0       # force a logfile segment switch after this
-               # time; 0 is off
+               # number of seconds; 0 is off
 
 
 #------------------------------------------------------------------------------
@@ -306,9 +306,10 @@
                    #   fatal
                    #   panic (effectively off)
 
-#log_min_duration_statement = -1ms # -1 is disabled, 0 logs all statements
+#log_min_duration_statement = -1   # -1 is disabled, 0 logs all statements
                    # and their durations, > 0 logs only
-                   # statements running at least this time.
+                   # statements running at least this number
+                   # of milliseconds
 
 #silent_mode = off         # DO NOT USE without syslog or
                    # logging_collector
@@ -346,7 +347,7 @@
 #log_lock_waits = off          # log lock waits >= deadlock_timeout
 #log_statement = 'none'            # none, ddl, mod, all
 #log_temp_files = -1           # log temporary files equal or larger
-                   # than specified size;
+                   # than the specified size in kilobytes;
                    # -1 disables, 0 logs all temp files
 #log_timezone = unknown            # actually, defaults to TZ environment
                    # setting
@@ -382,7 +383,8 @@
                    # requires track_counts to also be on.
 #log_autovacuum_min_duration = -1  # -1 disables, 0 logs all actions and
                    # their durations, > 0 logs only
-                   # actions running at least that time.
+                   # actions running at least this number
+                   # of milliseconds.
 #autovacuum_max_workers = 3        # max number of autovacuum subprocesses
 #autovacuum_naptime = 1min     # time between autovacuum runs
 #autovacuum_vacuum_threshold = 50  # min number of row updates before
@@ -393,9 +395,9 @@
 #autovacuum_analyze_scale_factor = 0.1 # fraction of table size before analyze
 #autovacuum_freeze_max_age = 200000000 # maximum XID age before forced vacuum
                    # (change requires restart)
-#autovacuum_vacuum_cost_delay = 20 # default vacuum cost delay for
-                   # autovacuum, -1 means use
-                   # vacuum_cost_delay
+#autovacuum_vacuum_cost_delay = 20ms   # default vacuum cost delay for
+                   # autovacuum, in milliseconds;
+                   # -1 means use vacuum_cost_delay
 #autovacuum_vacuum_cost_limit = -1 # default vacuum cost limit for
                    # autovacuum, -1 means use
                    # vacuum_cost_limit
@@ -415,7 +417,7 @@
 #default_transaction_isolation = 'read committed'
 #default_transaction_read_only = off
 #session_replication_role = 'origin'
-#statement_timeout = 0         # 0 is disabled
+#statement_timeout = 0         # in milliseconds, 0 is disabled
 #vacuum_freeze_min_age = 50000000
 #vacuum_freeze_table_age = 150000000
 #xmlbinary = 'base64'