From: Adam Dickmeiss <adam@indexdata.dk>
Date: Fri, 6 Mar 2015 10:14:57 +0000 (+0100)
Subject: Update and fix documentation for preferred targets
X-Git-Tag: v1.8.7~15
X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=790995e4dcd6f46f801917d770f550fe6bf2f859;p=pazpar2-moved-to-github.git

Update and fix documentation for preferred targets
---

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 1d9d479..8d64acc 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -1451,10 +1451,11 @@
      <listitem>
       <para>
        Specifies that a target is preferred, e.g. possible local, faster
-       target. Using block=pref on show command will wait for all these
+       target. Using block=preferred on <link linkend="command-show">
+       show command</link> will wait for all these
        targets to return records before releasing the block.
-       If no target is preferred, the block=pref will identical to block=1,
-       which release when one target has returned records.
+       If no target is preferred, the block=preferred will identical to
+       block=1, which release when one target has returned records.
       </para>
      </listitem>
     </varlistentry>
diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 7540224..4629cbf 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -429,6 +429,11 @@ search.pz2?session=2044502273&command=stat
 	ready to display. Use this to show first records rapidly without
 	requiring rapid polling.
        </para>
+       <para>
+	If block is set to <literal>preferred</literal>, the command will
+	wait until records have been received from all databases with preferred
+	setting
+       </para>
       </listitem>
      </varlistentry>