Skip to content

Commit f9b809e

Browse files
committed
Doc: copy-editing for debug_invalidate_system_caches_always description.
I came to fix "useful only useful", but the more I looked at the text the more things I thought could be improved.
1 parent 9681f21 commit f9b809e

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

doc/src/sgml/config.sgml

+10-9
Original file line numberDiff line numberDiff line change
@@ -10406,28 +10406,29 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
1040610406
</term>
1040710407
<listitem>
1040810408
<para>
10409-
When set to 1, each cache lookup for a system catalog entry is
10410-
invalidated at the first possible opportunity, irrespective of whether
10409+
When set to <literal>1</literal>, each system catalog cache entry is
10410+
invalidated at the first possible opportunity, whether or not
1041110411
anything that would render it invalid really occurred. Caching of
1041210412
system catalogs is effectively disabled as a result, so the server
1041310413
will run extremely slowly. Higher values run the cache invalidation
10414-
recursively, which is even slower and useful only useful for testing
10415-
in very specific scenarios.
10414+
recursively, which is even slower and only useful for testing
10415+
the caching logic itself. The default value of <literal>0</literal>
10416+
selects normal catalog caching behavior.
1041610417
</para>
1041710418

1041810419
<para>
10419-
This option can be very helpful when trying to trigger
10420-
hard-to-reproduce bugs involving concurrency and catalog changes but
10420+
This parameter can be very helpful when trying to trigger
10421+
hard-to-reproduce bugs involving concurrent catalog changes, but it
1042110422
is otherwise rarely needed. See the source code files
1042210423
<filename>inval.c</filename> and
1042310424
<filename>pg_config_manual.h</filename> for details.
1042410425
</para>
1042510426

1042610427
<para>
10427-
This setting is supported but off by default (0) when
10428-
<symbol>CLOBBER_CACHE_ENABLED</symbol> is defined at compile time
10428+
This parameter is supported when
10429+
<symbol>CLOBBER_CACHE_ENABLED</symbol> was defined at compile time
1042910430
(which happens automatically when using the
10430-
<literal>configure</literal> option
10431+
<application>configure</application> option
1043110432
<option>--enable-cassert</option>). In production builds, its value
1043210433
will always be <literal>0</literal> and attempts to set it to another
1043310434
value will raise an error.

0 commit comments

Comments
 (0)