Skip to content

Commit 2813167

Browse files
Fix cache custom settings
The nhibernate session factory configuration settings is restricted by a xsd. Adjust documentation of custom settings for reflecting this.
1 parent 274cf37 commit 2813167

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

doc/reference/modules/nhibernate_caches.xml

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,10 @@
204204
file system where the Prevalence engine will save data. It can be relative to the current directory or a
205205
full path. If the directory doesn't exist, it will be created.
206206
</para>
207+
<para>
208+
The <literal>prevalenceBase</literal> setting can only be set programmatically through on the NHibernate
209+
configuration object, by example with <literal>Configuration.SetProperty</literal>.
210+
</para>
207211
</section>
208212

209213
<section id="NHibernate.Caches.SysCache">
@@ -215,11 +219,12 @@
215219

216220
<variablelist>
217221
<varlistentry>
218-
<term><literal>expiration</literal></term>
222+
<term><literal>cache.default_expiration</literal></term>
219223
<listitem>
220224
Number of seconds to wait before expiring each item.
221-
Takes precedence over <literal>cache.default_expiration</literal>.
222-
If none of them are defined, defaults to <literal>300</literal>.
225+
Defaults to <literal>300</literal>. It can also be set programmatically on the NHibernate
226+
configuration object under the name <literal>expiration</literal>, which then takes precedence
227+
over <literal>cache.default_expiration</literal>.
223228
</listitem>
224229
</varlistentry>
225230
<varlistentry>
@@ -233,8 +238,9 @@
233238
<term><literal>priority</literal></term>
234239
<listitem>
235240
A numeric cost of expiring each item, where 1 is a low cost, 5 is the highest, and 3 is normal.
236-
Only values 1 through 5 are valid. 6 is a special value corresponding to
237-
<literal>NotRemovable</literal>, it should not be used.
241+
Only values 1 through 6 are valid. 6 is a special value corresponding to
242+
<literal>NotRemovable</literal>. This setting can only be set programmatically through on the
243+
NHibernate configuration object, by example with <literal>Configuration.SetProperty</literal>.
238244
</listitem>
239245
</varlistentry>
240246
</variablelist>
@@ -276,11 +282,12 @@
276282

277283
<variablelist>
278284
<varlistentry>
279-
<term><literal>expiration</literal></term>
285+
<term><literal>cache.default_expiration</literal></term>
280286
<listitem>
281287
Number of seconds to wait before expiring each item.
282-
Takes precedence over <literal>cache.default_expiration</literal>.
283-
If none of them are defined, defaults to <literal>300</literal>.
288+
Defaults to <literal>300</literal>. It can also be set programmatically on the NHibernate
289+
configuration object under the name <literal>expiration</literal>, which then takes precedence
290+
over <literal>cache.default_expiration</literal>.
284291
</listitem>
285292
</varlistentry>
286293
<varlistentry>
@@ -577,11 +584,12 @@
577584

578585
<variablelist>
579586
<varlistentry>
580-
<term><literal>expiration</literal></term>
587+
<term><literal>cache.default_expiration</literal></term>
581588
<listitem>
582589
Number of seconds to wait before expiring each item.
583-
Takes precedence over <literal>cache.default_expiration</literal>.
584-
If none of them are defined, defaults to <literal>300</literal>.
590+
Defaults to <literal>300</literal>. It can also be set programmatically on the NHibernate
591+
configuration object under the name <literal>expiration</literal>, which then takes precedence
592+
over <literal>cache.default_expiration</literal>.
585593
</listitem>
586594
</varlistentry>
587595
<varlistentry>

0 commit comments

Comments
 (0)