Porting::updateAUTHORS - Library to automatically update AUTHORS and .mailmap based on commit data.
use Porting::updateAUTHORS; my $updater= Porting::updateAUTHORS->new( authors_file => "AUTHORS", mailmap_file => ".mailmap", exclude_file => "Porting/exclude_contrib.txt", ); $updater->read_and_update();
This the brain of the Porting/updateAUTHORS.pl script. It is expected to be used from that script and by that script. Most features and options are documented in the Porting/updateAUTHORS.pl and are not explicitly documented here, read the Porting/updateAUTHORS.pl manpage for more details.
Porting::updateAUTHORS uses OO as way of managing its internal state. This documents the public methods it exposes.
If any additions were identified while reading the commits this will inject them into the mailmap_hash so they can be written out. Returns a count of additions found.
Analyzes the data contained the in the .mailmap file and applies any automated fixes which are required and which it can automatically perform. Returns a hash of adjusted entries and a hash with additional metadata about the mailmap entries.
Create a new object. Required parameters are
authors_file mailmap_file exclude_file
Other supported parameters are as follows:
verbose commit_range
this list is not exhaustive. See the code implementing the main() function in Porting/updateAUTHORS.pl for an exhaustive list.
Takes a mailmap_hash and parses it and returns it as an array of array records with the contents:
[ $preferred_name, $preferred_email, $other_name, $other_email, $line_num ]
Wraps the other functions in this library and implements the logic and intent of this tool. Takes two arguments, the authors file name, and the mailmap file name. Returns nothing but may modify the AUTHORS file or the .mailmap file. Requires that both files are editable.
Read the commit log specified by the property "commit_range" and find any new names it contains.
Normally used via read_and_update and not called directly.
read_and_update
Read the AUTHORS file into the object, and return data about it.
Read the .mailmap file into the object and return data about it.
Read the exclusion file into the object and return data about it.
Write out an updated AUTHORS file atomically if it has changed, returns 0 if the file was actually updated, 1 if it was not.
Write out an updated .mailmap file atomically if it has changed, returns 0 if the file was actually updated, 1 if it was not.
Write out an updated exclusion file atomically if it has changed, returns 0 if the file was actually update, 1 if it was not.
More documentation and testing.
Porting/checkAUTHORS.pl
Yves Orton <demerphq@gmail.com>
To install less, copy and paste the appropriate command in to your terminal.
cpanm
cpanm less
CPAN shell
perl -MCPAN -e shell install less
For more information on module installation, please visit the detailed CPAN module installation guide.