From 5aa0cf72bb8583f20c1eb85c8e712a0111df9a17 Mon Sep 17 00:00:00 2001 From: Hardy Ferentschik Date: Fri, 21 Oct 2011 15:38:22 +0200 Subject: [PATCH] HSEARCH-949 Switching from 'literal' to 'property' in tables. More appropriate and renders nicer in HTML. In pdf is still does not allow line breaks --- .../docbook/en-US/modules/configuration.xml | 107 +++++++----------- 1 file changed, 40 insertions(+), 67 deletions(-) diff --git a/hibernate-search-documentation/src/main/docbook/en-US/modules/configuration.xml b/hibernate-search-documentation/src/main/docbook/en-US/modules/configuration.xml index 179a3f087c7..6bc35d463ff 100755 --- a/hibernate-search-documentation/src/main/docbook/en-US/modules/configuration.xml +++ b/hibernate-search-documentation/src/main/docbook/en-US/modules/configuration.xml @@ -105,7 +105,7 @@ strategy, back ends and directory providers. Refer to , and for more details. + linkend="configuration-reader-strategy" /> for more details.
@@ -241,7 +241,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - ram: Memory based directory, the + ram: Memory based directory, the directory will be uniquely identified (in the same deployment unit) by the @Indexed.index element @@ -249,9 +249,9 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - filesystem: File system based directory. - The directory used will be <indexBase>/< indexName - > + filesystem: File system based + directory. The directory used will be <indexBase>/< + indexName > indexBase : Base directoryindexName: override @@ -278,7 +278,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - filesystem-master: File system + filesystem-master: File system based directory. Like filesystem. It also copies the index to a source directory (aka copy directory) on a regular basis.The recommended value for the refresh @@ -326,7 +326,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - filesystem-slave: File system + filesystem-slave: File system based directory. Like filesystem, but retrieves a master version (source) on a regular basis. To avoid locking and inconsistent search results, 2 local copies are @@ -389,7 +389,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - infinispan: Infinispan based + infinispan: Infinispan based directory. Use it to store the index in a distributed grid, making index changes visible to all elements of the cluster very quickly. Also see for additional @@ -590,7 +590,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - hibernate.search.worker.scope + hibernate.search.worker.scope The fully qualifed class name of the Worker implementation to use. If this @@ -600,7 +600,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - hibernate.search.worker.* + hibernate.search.worker.* All configuration properties prefixed with hibernate.search.worker are passed to the @@ -609,7 +609,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - hibernate.search.worker.batch_size + hibernate.search.worker.batch_size Defines the maximum number of indexing operation batched per context. Once the limit is reached indexing will be triggered @@ -649,7 +649,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - hibernate.search.<indexName>.worker.execution + hibernate.search.<indexName>.worker.execution sync: synchronous execution (default)async: asynchronous @@ -657,7 +657,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - hibernate.search.<indexName>.worker.thread_pool.size + hibernate.search.<indexName>.worker.thread_pool.size The backend can apply updates from the same transaction context (or batch) in parallel, using a threadpool. The default @@ -666,7 +666,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - hibernate.search.<indexName>.worker.buffer_queue.max + hibernate.search.<indexName>.worker.buffer_queue.max Defines the maximal number of work queue if the thread poll is starved. Useful only for asynchronous execution. Default to @@ -697,7 +697,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - hibernate.search.<indexName>.worker.backend + hibernate.search.<indexName>.worker.backend lucene: The default backend which runs index updates in the same VM. Also used when the property is @@ -738,14 +738,14 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - hibernate.search.<indexName>.worker.jndi.* + hibernate.search.<indexName>.worker.jndi.* Defines the JNDI properties to initiate the InitialContext (if needed). JNDI is only used by the JMS back end. - hibernate.search.<indexName>.worker.jms.connection_factory + hibernate.search.<indexName>.worker.jms.connection_factory Mandatory for the JMS back end. Defines the JNDI name to lookup the JMS connection factory from @@ -754,7 +754,7 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - hibernate.search.<indexName>.worker.jms.queue + hibernate.search.<indexName>.worker.jms.queue Mandatory for the JMS back end. Defines the JNDI name to lookup the JMS queue from. The queue will be used to post work @@ -776,14 +776,14 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - hibernate.search.<indexName>.worker.jgroups.clusterName + hibernate.search.<indexName>.worker.jgroups.clusterName Optional for JGroups back end. Defines the name of JGroups channel. - hibernate.search.<indexName>.worker.jgroups.configurationFile + hibernate.search.<indexName>.worker.jgroups.configurationFile Optional JGroups network stack configuration. Defines the name of a JGroups configuration file, which must exist on @@ -791,14 +791,14 @@ hibernate.search.Actions.directory_provider com.acme.hibernate.CustomDirectoryPr - hibernate.search.<indexName>.worker.jgroups.configurationXml + hibernate.search.<indexName>.worker.jgroups.configurationXml Optional JGroups network stack configuration. Defines a String representing JGroups configuration as XML. - hibernate.search.<indexName>.worker.jgroups.configurationString + hibernate.search.<indexName>.worker.jgroups.configurationString Optional JGroups network stack configuration. Provides JGroups configuration in plain text. @@ -1191,9 +1191,7 @@ hibernate.search.default.indexwriter.ram_buffer_size 64 - hibernate.search. -[default|<indexname>]. -exclusive_index_use + hibernate.search.[default|<indexname>].exclusive_index_use @@ -1209,9 +1207,7 @@ exclusive_index_use - hibernate.search. -[default|<indexname>]. -max_queue_length + hibernate.search.[default|<indexname>].max_queue_length @@ -1230,9 +1226,7 @@ max_queue_length - hibernate.search. -[default|<indexname>]. -indexwriter.max_buffered_delete_terms + hibernate.search.[default|<indexname>].indexwriter.max_buffered_delete_terms @@ -1247,9 +1241,7 @@ indexwriter.max_buffered_delete_terms - hibernate.search. -[default|<indexname>]. -indexwriter.max_buffered_docs + hibernate.search.[default|<indexname>].indexwriter.max_buffered_docs @@ -1262,9 +1254,7 @@ indexwriter.max_buffered_docs - hibernate.search. -[default|<indexname>]. -indexwriter.max_merge_docs + hibernate.search.[default|<indexname>].indexwriter.max_merge_docs @@ -1279,9 +1269,7 @@ indexwriter.max_merge_docs - hibernate.search. -[default|<indexname>]. -indexwriter.merge_factor + hibernate.search.[default|<indexname>].indexwriter.merge_factor @@ -1303,9 +1291,7 @@ indexwriter.merge_factor - hibernate.search. -[default|<indexname>]. -indexwriter.merge_min_size + hibernate.search.[default|<indexname>].indexwriter.merge_min_size @@ -1327,9 +1313,7 @@ indexwriter.merge_min_size - hibernate.search. -[default|<indexname>]. -indexwriter.merge_max_size + hibernate.search.[default|<indexname>].indexwriter.merge_max_size @@ -1352,9 +1336,7 @@ indexwriter.merge_max_size - hibernate.search. -[default|<indexname>]. -indexwriter.merge_max_optimize_size + hibernate.search.[default|<indexname>].indexwriter.merge_max_optimize_size @@ -1374,9 +1356,7 @@ indexwriter.merge_max_optimize_size - hibernate.search. -[default|<indexname>]. -indexwriter.merge_calibrate_by_deletes + hibernate.search.[default|<indexname>].indexwriter.merge_calibrate_by_deletes @@ -1397,9 +1377,7 @@ indexwriter.merge_calibrate_by_deletes - hibernate.search. -[default|<indexname>]. -indexwriter.ram_buffer_size + hibernate.search.[default|<indexname>].indexwriter.ram_buffer_size @@ -1417,9 +1395,7 @@ indexwriter.ram_buffer_size - hibernate.search. -[default|<indexname>]. -indexwriter.term_index_interval + hibernate.search.[default|<indexname>].indexwriter.term_index_interval @@ -1436,9 +1412,7 @@ indexwriter.term_index_interval - hibernate.search. -[default|<indexname>]. -indexwriter.use_compound_file + hibernate.search.[default|<indexname>].indexwriter.use_compound_file The advantage of using the compound file format is that @@ -1456,8 +1430,7 @@ indexwriter.use_compound_file - hibernate.search. -enable_dirty_check + hibernate.search.enable_dirty_check @@ -1586,7 +1559,7 @@ hibernate.search.default.indexwriter.merge_max_size 7 - simple + simple org.apache.lucene.store.SimpleFSLockFactory @@ -1602,7 +1575,7 @@ hibernate.search.default.indexwriter.merge_max_size 7 - native + native org.apache.lucene.store.NativeFSLockFactory @@ -1614,7 +1587,7 @@ hibernate.search.default.indexwriter.merge_max_size 7 - single + single org.apache.lucene.store.SingleInstanceLockFactory @@ -1626,7 +1599,7 @@ hibernate.search.default.indexwriter.merge_max_size 7 - none + none org.apache.lucene.store.NoLockFactory