Improve -j documentation

Change-Id: Id58170471aae82eaa375eadaad91bad2ecafcc3b
KorAP · Apr 17, 2024 · 2912826 · 2912826
1 parent c0ac4ff
commit 2912826
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 8 deletions.
diff --git a/Readme.pod b/Readme.pod
@@ -203,16 +203,18 @@ the unicode symbol 'Black Vertical Rectangle' aka \x25ae.
 
 =item B<--jobs|-j>
 
-Define the number of concurrent jobs in seperated forks
-for archive processing.
+Define the number of spawned forks for concurrent jobs
+of archive processing.
 Defaults to C<0> (everything runs in a single process).
 
 If C<sequential-extraction> is not set to true, this will
 also apply to extraction.
 
 Pass -1, and the value will be set automatically to 5
 times the number of available cores, in case L<Sys::Info>
-is available.
+is available. Be aware, that the report of available cores
+may not work in certain conditions. Benchmarking the processing
+speed based on the number of jobs may be valuable.
 This is I<experimental>.
 
 
@@ -285,7 +287,8 @@ of key-value pairs with whitespace separator
 
 Supported parameters are:
 C<overwrite>, C<gzip>, C<jobs>, C<input-base>,
-C<token>, C<log>, C<cache>, C<cache-size>, C<cache-delete>, C<meta>,
+C<token>, C<log>,
+C<cache>, C<cache-size>, C<cache-init>, C<cache-delete>, C<meta>,
 C<output>, C<koral>,
 C<temporary-extract>, C<sequential-extraction>,
 C<base-sentences>, C<base-paragraphs>,

diff --git a/script/korapxml2krill b/script/korapxml2krill
@@ -1289,16 +1289,18 @@ the unicode symbol 'Black Vertical Rectangle' aka \x25ae.
 
 =item B<--jobs|-j>
 
-Define the number of concurrent jobs in seperated forks
-for archive processing.
+Define the number of spawned forks for concurrent jobs
+of archive processing.
 Defaults to C<0> (everything runs in a single process).
 
 If C<sequential-extraction> is not set to true, this will
 also apply to extraction.
 
 Pass -1, and the value will be set automatically to 5
 times the number of available cores, in case L<Sys::Info>
-is available.
+is available. Be aware, that the report of available cores
+may not work in certain conditions. Benchmarking the processing
+speed based on the number of jobs may be valuable.
 This is I<experimental>.
 
 
@@ -1703,7 +1705,7 @@ Copyright (C) 2015-2024, L<IDS Mannheim|https://www.ids-mannheim.de/>
 
 Author: L<Nils Diewald|https://www.nils-diewald.de/>
 
-Contributor: Eliza Margaretha
+Contributor: Eliza Margaretha, Marc Kupietz
 
 L<KorAP::XML::Krill> is developed as part of the L<KorAP|https://korap.ids-mannheim.de/>
 Corpus Analysis Platform at the