Skip to content

Commit 2912826

Browse files
committed
Improve -j documentation
Change-Id: Id58170471aae82eaa375eadaad91bad2ecafcc3b
1 parent c0ac4ff commit 2912826

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

Readme.pod

+7-4
Original file line numberDiff line numberDiff line change
@@ -203,16 +203,18 @@ the unicode symbol 'Black Vertical Rectangle' aka \x25ae.
203203

204204
=item B<--jobs|-j>
205205

206-
Define the number of concurrent jobs in seperated forks
207-
for archive processing.
206+
Define the number of spawned forks for concurrent jobs
207+
of archive processing.
208208
Defaults to C<0> (everything runs in a single process).
209209

210210
If C<sequential-extraction> is not set to true, this will
211211
also apply to extraction.
212212

213213
Pass -1, and the value will be set automatically to 5
214214
times the number of available cores, in case L<Sys::Info>
215-
is available.
215+
is available. Be aware, that the report of available cores
216+
may not work in certain conditions. Benchmarking the processing
217+
speed based on the number of jobs may be valuable.
216218
This is I<experimental>.
217219

218220

@@ -285,7 +287,8 @@ of key-value pairs with whitespace separator
285287

286288
Supported parameters are:
287289
C<overwrite>, C<gzip>, C<jobs>, C<input-base>,
288-
C<token>, C<log>, C<cache>, C<cache-size>, C<cache-delete>, C<meta>,
290+
C<token>, C<log>,
291+
C<cache>, C<cache-size>, C<cache-init>, C<cache-delete>, C<meta>,
289292
C<output>, C<koral>,
290293
C<temporary-extract>, C<sequential-extraction>,
291294
C<base-sentences>, C<base-paragraphs>,

script/korapxml2krill

+6-4
Original file line numberDiff line numberDiff line change
@@ -1289,16 +1289,18 @@ the unicode symbol 'Black Vertical Rectangle' aka \x25ae.
12891289
12901290
=item B<--jobs|-j>
12911291
1292-
Define the number of concurrent jobs in seperated forks
1293-
for archive processing.
1292+
Define the number of spawned forks for concurrent jobs
1293+
of archive processing.
12941294
Defaults to C<0> (everything runs in a single process).
12951295
12961296
If C<sequential-extraction> is not set to true, this will
12971297
also apply to extraction.
12981298
12991299
Pass -1, and the value will be set automatically to 5
13001300
times the number of available cores, in case L<Sys::Info>
1301-
is available.
1301+
is available. Be aware, that the report of available cores
1302+
may not work in certain conditions. Benchmarking the processing
1303+
speed based on the number of jobs may be valuable.
13021304
This is I<experimental>.
13031305
13041306
@@ -1703,7 +1705,7 @@ Copyright (C) 2015-2024, L<IDS Mannheim|https://www.ids-mannheim.de/>
17031705
17041706
Author: L<Nils Diewald|https://www.nils-diewald.de/>
17051707
1706-
Contributor: Eliza Margaretha
1708+
Contributor: Eliza Margaretha, Marc Kupietz
17071709
17081710
L<KorAP::XML::Krill> is developed as part of the L<KorAP|https://korap.ids-mannheim.de/>
17091711
Corpus Analysis Platform at the

0 commit comments

Comments
 (0)