Skip to content
Permalink
Browse files

Documentation cleanups for github release.

  • Loading branch information
wsnyder committed Oct 26, 2019
1 parent fec1401 commit 346fd5410d1f0a7e760e749ba2672e18233e568a
Showing with 42 additions and 65 deletions.
  1. +4 −0 Changes
  2. +1 −1 META.yml
  3. +3 −8 Makefile.PL
  4. +32 −54 README.pod
  5. +1 −1 lib/Parallel/Forker.pm
  6. +1 −1 lib/Parallel/Forker/Process.pm
@@ -2,6 +2,10 @@ Revision history for Perl extension Parallel::Forker

The contributors that suggested a given feature are shown in [].

* Parallel::Forker 1.252 devel

**** Documentation cleanups for github release.

* Parallel::Forker 1.250 2019-09-17

**** Fix CPAN missing tarball, no functional change.
@@ -8,7 +8,7 @@ license: perl
author:
- Wilson Snyder <wsnyder@wsnyder.org>
resources:
homepage: http://www.veripool.org
homepage: https://www.veripool.org/parallel-forker
requires:
Proc::ProcessTable: 0.4
Scalar::Util: 0
@@ -11,15 +11,10 @@ use Carp;

sub MY::postamble {
q{
all:: README
README: README.pod
-$(RM_RF) $@
pod2text --loose $< > $@
all::
preexist:
svnorcvs nexists $(DISTNAME)_$(VERSION_SYM)
test -s README
tag:
svnorcvs tag $(DISTNAME)_$(VERSION_SYM)
@@ -33,7 +28,7 @@ maintainer-dist: preexist dist tag
maintainer-clean: distclean
-$(RM_RF) README
maintainer-copy: README
maintainer-copy:
clean::
-$(RM_RF) test_dir
@@ -53,7 +48,7 @@ WriteMakefile(
},
'dist' => {COMPRESS => 'gzip -9f',
SUFFIX => '.gz',
DIST_DEFAULT => 'README all tardist',
DIST_DEFAULT => 'all tardist',
},
);

@@ -1,76 +1,54 @@
# -*- Perl -*-
# See copyright, etc in below POD section.
######################################################################

=pod

=head1 NAME
=head1 SUMMARY

Parallel::Forker README file
Parallel::Forker is a Perl package to manage parallel processes that are
either subroutines or system commands. Parallel::Forker supports being
able to specify complicated expressions to determine which processes run
after others, or processes that run when processes others fail.

=head1 DESCRIPTION
=head1 EXAMPLE

Parallel::Forker manages parallel processes that are either subroutines or
system commands. Forker supports most of the features in all the other
little packages out there, with the addition of being able to specify
complicated expressions to determine which processes run after others, or
run when others fail.
use Parallel::Forker;
$Fork = new Parallel::Forker(use_sig_child=>1);
$Fork->schedule
(run_on_start => sub {print "child work here...";},
# run_on_start => \&child_subroutine, # Alternative: call a named sub.
run_on_finish => sub {print "parent cleanup here...";},
)->run;
$Fork->wait_all; # Wait for all children to finish

=head1 INSTALLATION

Skip this section if Parallel::Forker has already been installed.
=head2 Supported Systems
Parallel::Forker should run on any system with Perl.
=head2 CPAN Installation
=over 4
Easiest installation is using the "CPAN" command line that comes with Perl.
After configuring CPAN the first time, simply
$ cpan
cpan> install Parallel::Forker
Read the rest of this file for details on the programs provided.
=head2 Install from CPAN:

=back
cpan install Parallel::Forker

=head2 Manual Installation
=head2 Or, build from sources:

=over 4
# Obtain distribution kit
git clone git@github.com:veripool/Parallel-Forker.git
# Build
cd Parallel-Forker
git pull
perl Makefile.PL
make
make test
make install

Download the latest version from L<http://www.perl.org/CPAN/>.
C<cd> to the directory containing this README notice.
Type C<perl Makefile.PL> to configure for your system.
Type C<make> to compile.
Type C<make test> to check the package.
Type C<make install> to install the programs and any data files and
documentation.
=back
=head1 USAGE
=head1 DOCUMENTATION

See the L<Parallel::Forker> manpage after installation.

=head1 DISTRIBUTION
=head1 LICENSE

The latest version is available from CPAN.
The latest version is available from CPAN and from
L<https://www.veripool.org/parallel-forker>.

Copyright 2002-2019 by Wilson Snyder. This package is free software; you
can redistribute it and/or modify it under the terms of either the GNU
Lesser General Public License Version 3 or the Perl Artistic License Version 2.0.
This code is provided with no warranty of any kind, and is used entirely at
your own risk.
Lesser General Public License Version 3 or the Perl Artistic License
Version 2.0.

=head1 AUTHORS

@@ -554,7 +554,7 @@ Print a dump of the execution tree.
=head1 DISTRIBUTION
The latest version is available from CPAN and from
L<http://www.veripool.org/>.
L<https://www.veripool.org/parallel-forker>.
Copyright 2002-2019 by Wilson Snyder. This package is free software; you
can redistribute it and/or modify it under the terms of either the GNU
@@ -579,7 +579,7 @@ undef.
=head1 DISTRIBUTION
The latest version is available from CPAN and from
L<http://www.veripool.org/>.
L<https://www.veripool.org/parallel-forker>.
Copyright 2002-2019 by Wilson Snyder. This package is free software; you
can redistribute it and/or modify it under the terms of either the GNU

0 comments on commit 346fd54

Please sign in to comment.
You can’t perform that action at this time.