From bf5f74bc130c91801b7c0e6a1bcd82a408e01893 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Mon, 26 Aug 2019 08:35:34 +0200 Subject: [PATCH] document pyloglevel and pylogfilename --- src/doc/user/recoll.conf.xml | 11 ++++ src/doc/user/usermanual.html | 101 +++++++++++++++++++++-------------- src/doc/user/usermanual.xml | 37 ++++++------- src/sampleconf/recoll.conf | 12 ++++- 4 files changed, 98 insertions(+), 63 deletions(-) diff --git a/src/doc/user/recoll.conf.xml b/src/doc/user/recoll.conf.xml index f9dc94a4..35ae5134 100644 --- a/src/doc/user/recoll.conf.xml +++ b/src/doc/user/recoll.conf.xml @@ -38,6 +38,11 @@ list. skippedNames+ List of name endings to add to the default skippedNames list. + +onlyNames +Regular file name filter patterns If this is set, only the file names not in skippedNames and +matching one of the patterns will be considered for indexing. Can be +redefined per subtree. Does not apply to directories. noContentSuffixes List of name endings (not necessarily dot-separated suffixes) for @@ -526,6 +531,12 @@ the log... values. Override logfilename for the indexer in real time mode. The default is to use the idx... values if set, else the log... values. + +pyloglevel +Override loglevel for the python module. + +pylogfilename +Override logfilename for the python module. orgidxconfdir Original location of the configuration directory. This is used exclusively for movable datasets. Locating the diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index d5222ca8..f1307bec 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -337,12 +337,15 @@ alink="#0000FF"> "#RCL.PROGRAM.PYTHONAPI.ELEMENTS">Interface elements
4.3.3. Log messages for + Python scripts
+
4.3.4. Python search interface
-
4.3.4. 4.3.5. Creating Python external indexers
-
4.3.5. 4.3.6. Package compatibility with the previous version
@@ -6530,34 +6533,9 @@ text/html [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r conjunction with regular ones, through the GUI or any of the query interfaces.

The search API is modeled along the Python database - API specification. There were two major changes along - Recoll versions:

-
-
    -
  • -

    The basis for the Recoll API changed from Python - database API version 1.0 (Recoll versions up to 1.18.1), - to version 2.0 (Recoll 1.18.2 and later).

    -
    • -
  • -

    The recoll module - became a package (with an internal recoll module) as of Recoll version 1.19, in order - to add more functions. For existing code, this only - changes the way the interface must be imported.

    -
    • -
-
-

We will describe the new API and package structure - here. A paragraph at the end of this section will explain - a few differences and ways to write code compatible with - both versions.

-

The recoll package now + API version 2.0 specification (early versions used the + version 1.0 spec).

+

The recoll package contains two modules:

    The rclextract module contains functions and classes used at query - time to access document data.

    + time to access document data. The recoll module must be imported + before rclextract

@@ -6583,13 +6563,11 @@ text/html [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r chapter.

As an introduction, the following small sample will run a query and list the title and url for each of the - results. It would work with Recoll 1.19 and later. The - python/samples source - directory contains several examples of Python programming - with Recoll, exercising - the extension more completely, and especially its data - extraction features.

+ results. The python/samples + source directory contains several examples of Python + programming with Recoll, + exercising the extension more completely, and especially + its data extraction features.

         #!/usr/bin/env python
 
@@ -6730,13 +6708,31 @@ text/html       [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r
             
           
         
+        

+          

+            

+              

+                
4.3.3. Log
+                messages for Python scripts

+              

+            

+          

+          
Two specific configuration variables: pyloglevel and pylogfilename allow overriding the
+          generic values for Python programs. Set pyloglevel to 2 to suppress default
+          startup messages (printed at level 3).

+        

         

           

             

               

                 
4.3.3. Python
+                "RCL.PROGRAM.PYTHONAPI.SEARCH">4.3.4. Python
                 search interface

               

             

@@ -7307,7 +7303,7 @@ for i in range(nres):
               

                 
4.3.4. Creating
+                "RCL.PROGRAM.PYTHONAPI.UPDATE">4.3.5. Creating
                 Python external indexers

               

             

@@ -7529,7 +7525,7 @@ for i in range(nres):
               

                 
4.3.5. Package
+                "RCL.PROGRAM.PYTHONAPI.COMPAT">4.3.6. Package
                 compatibility with the previous version

               

             

@@ -8422,6 +8418,16 @@ for i in range(nres):
                   skippedNames list.

                 
                 
onlyNames

+                

+                  
Regular file name filter patterns If this is
+                  set, only the file names not in skippedNames and
+                  matching one of the patterns will be considered
+                  for indexing. Can be redefined per subtree. Does
+                  not apply to directories.

+                

+                
noContentSuffixes

@@ -9268,6 +9274,19 @@ for i in range(nres):
                   values if set, else the log... values.

                 
                 
pyloglevel

+                

+                  
Override loglevel for the python module.

+                

+                
pylogfilename

+                

+                  
Override logfilename for the python
+                  module.

+                

+                
orgidxconfdir

                 

diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml
index b6bf8624..087fca65 100644
--- a/src/doc/user/usermanual.xml
+++ b/src/doc/user/usermanual.xml
@@ -5032,25 +5032,9 @@ text/html       [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r
         ones, through the GUI or any of the query interfaces.
 
         The search API is modeled along the Python database API
-        specification. There were two major changes along &RCL; versions:
-        
-          The basis for the &RCL; API changed from Python
-          database API version 1.0 (&RCL; versions up to 1.18.1),
-          to version 2.0 (&RCL; 1.18.2 and later).
-          The recoll module became a
-          package (with an internal recoll
-          module) as of &RCL; version 1.19, in order to add more
-          functions. For existing code, this only changes the way
-          the interface must be imported.
-        
-        
+        version 2.0 specification (early versions used the version 1.0 spec).
 
-        We will describe the new API and package structure here. A
-        paragraph at the end of this section will explain a few differences
-        and ways to write code compatible with both versions.
-
-        The recoll package now contains two
-        modules:
+        The recoll package contains two modules:
         
           The recoll module contains
           functions and classes used to query (or update) the
@@ -5058,7 +5042,8 @@ text/html       [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r
 
           The rclextract module contains
           functions and classes used at query time to access document
-          data.
+          data. The recoll module must be imported
+          before rclextract
           
         
 
@@ -5068,8 +5053,7 @@ text/html       [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r
         refer to the Building from source chapter.
 
         As an introduction, the following small sample will run a
-        query and list the title and url for each of the results. It would
-        work with &RCL; 1.19 and later. The
+        query and list the title and url for each of the results. The
         python/samples source directory contains
         several examples of Python programming with &RCL;, exercising the
         extension more completely, and especially its data extraction
@@ -5186,6 +5170,17 @@ text/html       [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r
 
       
 
+      
+        Log messages for Python scripts
+
+      Two specific configuration variables:
+      pyloglevel and pylogfilename
+      allow overriding the generic values for Python programs. Set
+      pyloglevel to 2 to suppress default startup messages
+      (printed at level 3).
+
+      
+      
       
         Python search interface
 
diff --git a/src/sampleconf/recoll.conf b/src/sampleconf/recoll.conf
index 3df74a2b..1836060a 100644
--- a/src/sampleconf/recoll.conf
+++ b/src/sampleconf/recoll.conf
@@ -60,7 +60,7 @@ skippedNames- =
 # list.
 skippedNames+ =
 
-# 
 # Regular file name filter patterns
 # If this is set, only the file names not in skippedNames and
 # matching one of the patterns will be considered for indexing. Can be
@@ -655,6 +655,16 @@ logfilename = stderr
 # the log... values.
 #daemlogfilename = /dev/null
 
+# 
+#
+# Override loglevel for the python module.
+#pyloglevel = 3
+
+# 
+#
+# Override logfilename for the python module.
+#pylogfilename = stderr
+
 # 
 #
 # Original location of the configuration directory.