tange/parallel
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/parallel.git synced 2024-11-22 22:17:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

parallel: Deal with 'parallel --citation < /dev/null'.

Browse source
This commit is contained in:
Ole Tange 2016-04-09 23:57:50 +02:00
parent dd793cee9d
commit 39fb9d179e
2 changed files with 91 additions and 69 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

154
src/parallel
View file

@ -855,7 +855,7 @@ sub options_hash {
"gnu" => \$opt::gnu, "gnu" => \$opt::gnu,
"xapply" => \$opt::xapply, "xapply" => \$opt::xapply,
"xapplyinputsource=i" => \@opt::xapplyinputsource, "xapplyinputsource=i" => \@opt::xapplyinputsource,
"bibtex|citation" => \$opt::bibtex, "bibtex|citation" => \$opt::citation,
"wc|willcite|will-cite|nn|nonotice|no-notice" => \$opt::willcite, "wc|willcite|will-cite|nn|nonotice|no-notice" => \$opt::willcite,
# Termination and retries # Termination and retries
"halt-on-error|halt=s" => \$opt::halt, "halt-on-error|halt=s" => \$opt::halt,
@ -988,7 +988,7 @@ sub parse_options {
print Limits::Command::real_max_length(),"\n"; wait_and_exit(0); print Limits::Command::real_max_length(),"\n"; wait_and_exit(0);
} }
if(defined $opt::version) { version(); wait_and_exit(0); } if(defined $opt::version) { version(); wait_and_exit(0); }
if(defined $opt::bibtex) { bibtex(); wait_and_exit(0); } if(defined $opt::citation) { citation(); wait_and_exit(0); }
if(defined $opt::record_env) { record_env(); wait_and_exit(0); } if(defined $opt::record_env) { record_env(); wait_and_exit(0); }
if(defined $opt::show_limits) { show_limits(); } if(defined $opt::show_limits) { show_limits(); }
if(@opt::sshlogin) { @Global::sshlogin = @opt::sshlogin; } if(@opt::sshlogin) { @Global::sshlogin = @opt::sshlogin; }
@ -2335,7 +2335,7 @@ sub drain_job_queue {
# $Global::start_no_new_jobs # $Global::start_no_new_jobs
# Returns: N/A # Returns: N/A
if($opt::progress) { if($opt::progress) {
::status(init_progress()); ::status_no_nl(init_progress());
} }
my $last_header = ""; my $last_header = "";
my $sleep = 0.2; my $sleep = 0.2;
@ -2352,10 +2352,10 @@ sub drain_job_queue {
if($opt::progress) { if($opt::progress) {
my %progress = progress(); my %progress = progress();
if($last_header ne $progress{'header'}) { if($last_header ne $progress{'header'}) {
::status("\n", $progress{'header'}, "\n"); ::status("", $progress{'header'});
$last_header = $progress{'header'}; $last_header = $progress{'header'};
} }
::status("\r",$progress{'status'}); ::status_no_nl("\r",$progress{'status'});
} }
if($Global::total_running < $Global::max_jobs_running if($Global::total_running < $Global::max_jobs_running
and not $Global::JobQueue->empty()) { and not $Global::JobQueue->empty()) {
@ -2407,7 +2407,7 @@ sub drain_job_queue {
$opt::sqlmaster and not $Global::sql->finished()); $opt::sqlmaster and not $Global::sql->finished());
if($opt::progress) { if($opt::progress) {
my %progress = progress(); my %progress = progress();
::status("\r", $progress{'status'}, "\n"); ::status("\r".$progress{'status'});
} }
} }
@ -2418,7 +2418,7 @@ sub toggle_progress {
# Returns: N/A # Returns: N/A
$opt::progress = not $opt::progress; $opt::progress = not $opt::progress;
if($opt::progress) { if($opt::progress) {
::status(init_progress()); ::status_no_nl(init_progress());
} }
} }
@ -3332,7 +3332,7 @@ sub list_running_jobs {
# %Global::running # %Global::running
# Returns: N/A # Returns: N/A
for my $job (values %Global::running) { for my $job (values %Global::running) {
::status("$Global::progname: ",$job->replaced(),"\n"); ::status("$Global::progname: ".$job->replaced());
} }
} }
@ -3346,9 +3346,9 @@ sub start_no_new_jobs {
$SIG{TERM} = $Global::original_sig{TERM}; $SIG{TERM} = $Global::original_sig{TERM};
unlink keys %Global::unlink; unlink keys %Global::unlink;
::status ::status
("$Global::progname: SIGTERM received. No new jobs will be started.\n", ("$Global::progname: SIGTERM received. No new jobs will be started.",
"$Global::progname: Waiting for these ", scalar(keys %Global::running), "$Global::progname: Waiting for these ".(keys %Global::running).
" jobs to finish. Send SIGTERM again to stop now.\n"); " jobs to finish. Send SIGTERM again to stop now.");
list_running_jobs(); list_running_jobs();
$Global::start_no_new_jobs ||= 1; $Global::start_no_new_jobs ||= 1;
} }
@ -3428,7 +3428,7 @@ sub reaper {
start_more_jobs(); start_more_jobs();
if($opt::progress) { if($opt::progress) {
my %progress = progress(); my %progress = progress();
::status("\r",$progress{'status'}); ::status_no_nl("\r",$progress{'status'});
} }
} }
$opt::sqlmaster and $Global::sql->run("COMMIT;"); $opt::sqlmaster and $Global::sql->run("COMMIT;");
@ -3559,7 +3559,7 @@ sub usage {
" ;login: The USENIX Magazine, February 2011:42-47.", " ;login: The USENIX Magazine, February 2011:42-47.",
"", "",
"This helps funding further development; AND IT WON'T COST YOU A CENT.", "This helps funding further development; AND IT WON'T COST YOU A CENT.",
"If you pay 10000 EUR you should feel free to use GNU Parallel without citing.\n", "If you pay 10000 EUR you should feel free to use GNU Parallel without citing.",
""); "");
} }
@ -3579,22 +3579,30 @@ sub citation_notice {
# skip # skip
} else { } else {
::status ::status
("Academic tradition requires you to cite works you base your article on.\n", ("Academic tradition requires you to cite works you base your article on.",
"When using programs that use GNU Parallel to process data for publication\n", "When using programs that use GNU Parallel to process data for publication",
"please cite:\n", "please cite:",
"\n", "",
" O. Tange (2011): GNU Parallel - The Command-Line Power Tool,\n", " O. Tange (2011): GNU Parallel - The Command-Line Power Tool,",
" ;login: The USENIX Magazine, February 2011:42-47.\n", " ;login: The USENIX Magazine, February 2011:42-47.",
"\n", "",
"This helps funding further development; AND IT WON'T COST YOU A CENT.\n", "This helps funding further development; AND IT WON'T COST YOU A CENT.",
"If you pay 10000 EUR you should feel free to use GNU Parallel without citing.\n", "If you pay 10000 EUR you should feel free to use GNU Parallel without citing.",
"\n", "",
"To silence the citation notice: run 'parallel --bibtex'.\n\n", "To silence the citation notice: run 'parallel --citation'.",
""
); );
} }
} }
sub status { sub status {
my @w = @_;
my $fh = $Global::status_fd || *STDERR;
print $fh map { ($_, "\n") } @w;
flush $fh;
}
sub status_no_nl {
my @w = @_; my @w = @_;
my $fh = $Global::status_fd || *STDERR; my $fh = $Global::status_fd || *STDERR;
print $fh @w; print $fh @w;
@ -3639,55 +3647,69 @@ sub version {
"", "",
"Web site: http://www.gnu.org/software/${Global::progname}\n", "Web site: http://www.gnu.org/software/${Global::progname}\n",
"When using programs that use GNU Parallel to process data for publication", "When using programs that use GNU Parallel to process data for publication",
"please cite as described in 'parallel --bibtex'.\n", "please cite as described in 'parallel --citation'.\n",
); );
} }
sub bibtex { sub citation {
# Returns: N/A # Returns: N/A
print join("\n", ::status(
"Academic tradition requires you to cite works you base your article on.", "Academic tradition requires you to cite works you base your article on.",
"When using programs that use GNU Parallel to process data for publication", "When using programs that use GNU Parallel to process data for publication",
"please cite:", "please cite:",
"", "",
"\@article{Tange2011a,", "\@article{Tange2011a,",
" title = {GNU Parallel - The Command-Line Power Tool},", " title = {GNU Parallel - The Command-Line Power Tool},",
" author = {O. Tange},", " author = {O. Tange},",
" address = {Frederiksberg, Denmark},", " address = {Frederiksberg, Denmark},",
" journal = {;login: The USENIX Magazine},", " journal = {;login: The USENIX Magazine},",
" month = {Feb},", " month = {Feb},",
" number = {1},", " number = {1},",
" volume = {36},", " volume = {36},",
" url = {http://www.gnu.org/s/parallel},", " url = {http://www.gnu.org/s/parallel},",
" year = {2011},", " year = {2011},",
" pages = {42-47},", " pages = {42-47},",
" doi = {10.5281/zenodo.16303}", " doi = {10.5281/zenodo.16303}",
"}", "}",
"", "",
"(Feel free to use \\nocite{Tange2011a})", "(Feel free to use \\nocite{Tange2011a})",
"", "",
"This helps funding further development; AND IT WON'T COST YOU A CENT.", "This helps funding further development; AND IT WON'T COST YOU A CENT.",
"If you pay 10000 EUR you should feel free to use GNU Parallel without citing.", "If you pay 10000 EUR you should feel free to use GNU Parallel without citing.",
"", "",
"If you send a copy of your published article to tange\@gnu.org, it will be", "If you send a copy of your published article to tange\@gnu.org, it will be",
"mentioned in the release notes of next version of GNU Parallel.\n\n", "mentioned in the release notes of next version of GNU Parallel.",
"",
""
); );
while(not -e $ENV{'HOME'}."/.parallel/will-cite") { while(not -e $ENV{'HOME'}."/.parallel/will-cite") {
print "\nType: 'will cite' and press enter.\n> "; print "\nType: 'will cite' and press enter.\n> ";
my $input = <STDIN>; my $input = <STDIN>;
if(not defined $input) {
exit(255);
}
if($input =~ /will cite/i) { if($input =~ /will cite/i) {
mkdir $ENV{'HOME'}."/.parallel"; mkdir $ENV{'HOME'}."/.parallel";
if(open (my $fh, ">", $ENV{'HOME'}."/.parallel/will-cite")) { if(open (my $fh, ">", $ENV{'HOME'}."/.parallel/will-cite")) {
close $fh; close $fh;
print "\nThank you for your support. It is much appreciated. The citation\n", ::status(
"notice is now silenced. For other ways to silence the citation notice\n", "",
"see 'man parallel' under '--bibtex'.\n\n"; "Thank you for your support. It is much appreciated. The citation",
"notice is now silenced.",
"");
} else { } else {
print "\nThank you for your support. It is much appreciated. The citation\n", ::status(
"cannot permanently be silenced. Use '--will-cite' instead.\n", "",
"If you use '--will-cite' in scripts you are making it harder to see the\n", "Thank you for your support. It is much appreciated. The citation",
"citation notice. However, if you pay 10000 EUR, you should feel free\n", "cannot permanently be silenced. Use '--will-cite' instead.",
"to use '--will-cite'.\n\n"; "",
"If you use '--will-cite' in scripts to be run by others you are making",
"it harder for others to see the citation notice. The development of",
"GNU parallel is indirectly financed through citations, so if users",
"do not know they should cite then you are making it harder to finance",
"development. However, if you pay 10000 EUR, you should feel free to",
"use --will-cite.",
"");
last; last;
} }
} }
@ -7575,7 +7597,7 @@ sub interactive_start {
my $self = shift; my $self = shift;
my $command = $self->wrapped(); my $command = $self->wrapped();
if($Global::interactive) { if($Global::interactive) {
::status("$command ?..."); ::status_no_nl("$command ?...");
open(my $tty_fh, "<", "/dev/tty") || ::die_bug("interactive-tty"); open(my $tty_fh, "<", "/dev/tty") || ::die_bug("interactive-tty");
my $answer = <$tty_fh>; my $answer = <$tty_fh>;
close $tty_fh; close $tty_fh;
@ -7663,7 +7685,7 @@ sub print_dryrun_and_verbose {
$ENV{'TMUX'} ||= "tmux"; $ENV{'TMUX'} ||= "tmux";
if(not $tmuxsocket) { if(not $tmuxsocket) {
$tmuxsocket = ::tmpname("tms"); $tmuxsocket = ::tmpname("tms");
::status("See output with: $ENV{'TMUX'} -S $tmuxsocket attach\n"); ::status("See output with: $ENV{'TMUX'} -S $tmuxsocket attach");
} }
$tmux = "sh -c '". $tmux = "sh -c '".
$ENV{'TMUX'}." -S $tmuxsocket new-session -s p$$ -d \"sleep .2\" >/dev/null 2>&1';" . $ENV{'TMUX'}." -S $tmuxsocket new-session -s p$$ -d \"sleep .2\" >/dev/null 2>&1';" .
@ -8125,8 +8147,8 @@ sub set_exitsignal {
$Global::exitstatus++; $Global::exitstatus++;
$Global::total_failed++; $Global::total_failed++;
if($Global::halt_fail) { if($Global::halt_fail) {
::status("$Global::progname: This job failed:\n", ::status("$Global::progname: This job failed:",
$job->replaced(),"\n"); $job->replaced());
if($Global::halt_count <= $Global::total_failed) { if($Global::halt_count <= $Global::total_failed) {
# At least N jobs had failed # At least N jobs had failed
if(not defined $Global::halt_exitstatus) { if(not defined $Global::halt_exitstatus) {
@ -8159,8 +8181,8 @@ sub set_exitsignal {
if($Global::halt_success) { if($Global::halt_success) {
::debug("halt","Pct: ",$Global::halt_pct,"<=", ::debug("halt","Pct: ",$Global::halt_pct,"<=",
" count: ",$Global::halt_count,"\n"); " count: ",$Global::halt_count,"\n");
::status("$Global::progname: This job succeeded:\n", ::status("$Global::progname: This job succeeded:",
$job->replaced(),"\n"); $job->replaced());
if($Global::halt_count <= if($Global::halt_count <=
$Global::total_completed-$Global::total_failed) { $Global::total_completed-$Global::total_failed) {
# At least N jobs had success # At least N jobs had success

6
src/parallel.pod
View file

@ -464,9 +464,9 @@ B<--will-cite>.
If you use B<--will-cite> in scripts to be run by others you are If you use B<--will-cite> in scripts to be run by others you are
making it harder for others to see the citation notice. The making it harder for others to see the citation notice. The
development of GNU B<parallel> is indirectly financed through development of GNU B<parallel> is indirectly financed through
citations, so if users do not know they should cite then that makes it citations, so if users do not know they should cite then you are
harder to finance development. However, if you pay 10000 EUR, you making it harder to finance development. However, if you pay 10000
should feel free to use B<--will-cite>. EUR, you should feel free to use B<--will-cite>.
=item B<--block> I<size> =item B<--block> I<size>