From 0396e2b868b9d91b24e06e34eba251741f77d054 Mon Sep 17 00:00:00 2001
From: Jean-Francois Dockes <jf@dockes.org>
Date: Mon, 16 Apr 2018 09:24:13 +0200
Subject: [PATCH] doc

---
 src/doc/man/recoll.conf.5    |  5 +++--
 src/doc/user/usermanual.html |  7 ++++---
 src/doc/user/usermanual.xml  | 11 ++++++-----
 3 files changed, 13 insertions(+), 10 deletions(-)

diff --git a/src/doc/man/recoll.conf.5 b/src/doc/man/recoll.conf.5
index 510094bb..ecc030b8 100644
--- a/src/doc/man/recoll.conf.5
+++ b/src/doc/man/recoll.conf.5
@@ -10,10 +10,11 @@ The system-wide configuration file is normally located inside
 may be overridden by setting it in the personal configuration file, by default:
 .IR $HOME/.recoll/recoll.conf
 .LP
-Please note while we try to keep this manual page reasonably up to date, it
+Please note while I try to keep this manual page reasonably up to date, it
 will frequently lag the current state of the software. The best source of
 information about the configuration are the comments in the system-wide
-configuration file.
+configuration file or the user manual which you can access from the recoll GUI
+help menu or on the recoll web site.
 
 .LP
 A short extract of the file might look as follows:
diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html
index ae01618a..60f819e2 100644
--- a/src/doc/user/usermanual.html
+++ b/src/doc/user/usermanual.html
@@ -1254,7 +1254,7 @@ alink="#0000FF">
         "link" href=
         "#RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS"><code class=
         "varname">topdirs</code></a>, which determines what
-        subtrees get indexed.</p>
+        subtrees and files get indexed.</p>
         <p>The applications needed to index file types other than
         text, HTML or email (ie: pdf, postscript, ms-word...) are
         described in the <a class="link" href=
@@ -6555,7 +6555,8 @@ recollindex -c "$confdir"
                     <dd>
                       <p>Fetches the next <code class=
                       "literal">Doc</code> object from the current
-                      search results.</p>
+                      search results. Generates a StopIteration
+                      exception if there are no results left.</p>
                     </dd>
                     <dt><span class=
                     "term">Query.close()</span></dt>
@@ -7845,7 +7846,7 @@ for i in range(nres):
         example, a short extract of the main configuration file
         might look as follows:</p>
         <pre class="programlisting">
-        # Space-separated list of directories to index.
+        # Space-separated list of files and directories to index.
         topdirs =  ~/docs /usr/share/doc
 
         [~/somedirectory-with-utf8-txt-files]
diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml
index 6a4946ac..5ba33102 100644
--- a/src/doc/user/usermanual.xml
+++ b/src/doc/user/usermanual.xml
@@ -722,7 +722,7 @@
       interested in is probably 
       <link linkend="RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS">
         <varname>topdirs</varname></link>, 
-      which determines what subtrees get indexed.</para>
+      which determines what subtrees and files get indexed.</para>
 
       <para>The applications needed to index file types other than
       text, HTML or email (ie: pdf, postscript, ms-word...) are
@@ -5095,9 +5095,10 @@ recollindex -c "$confdir"
                 </varlistentry>
 
                 <varlistentry>
-                  <term>Query.fetchone()</term>
-                  <listitem><para>Fetches the next <literal>Doc</literal> object
-                  from the current search results.</para></listitem>
+                  <term>Query.fetchone()</term> <listitem><para>Fetches the
+                  next <literal>Doc</literal> object from the current
+                  search results. Generates a StopIteration exception if
+                  there are no results left.</para></listitem>
                 </varlistentry>
 
                 <varlistentry>
@@ -6117,7 +6118,7 @@ for i in range(nres):
       example, a short extract of the main configuration file might
       look as follows:</para> 
       <programlisting>
-        # Space-separated list of directories to index.
+        # Space-separated list of files and directories to index.
         topdirs =  ~/docs /usr/share/doc
 
         [~/somedirectory-with-utf8-txt-files]