Chris Williams > perl > git-deltatool

Download:
perl-5.19.6.tar.bz2

Annotate this POD

Website

Source   Latest Release: perl-5.21.2

NAME ^

git-deltatool - Annotate commits for perldelta

SYNOPSIS ^

 # annotate commits back to last 'git describe' tag

 $ git-deltatool

 # review annotations

 $ git-deltatool --mode review

 # review commits needing help

 $ git-deltatool --mode review --type blocking

 # summarize commits needing help

 $ git-deltatool --mode summary --type blocking

 # assemble annotations by section to STDOUT

 $ git-deltatool --mode render

 # Get a list of commits needing further review, e.g. for peer review

 $ git-deltatool --mode summary --type blocking

 # mark 'pending' annotations as 'done' (i.e. added to perldelta)

 $ git-deltatool --mode update --type pending --status done

OPTIONS ^

--mode|-m MODE

Indicates the run mode for the program. The default is 'assign' which assigns categories and marks the notes as 'pending' (or 'ignored'). Other modes are 'review', 'render', 'summary' and 'update'.

--type|-t TYPE

Indicates what types of commits to process. The default for 'assign' mode is 'new', which processes commits without any perldelta notes. The default for 'review', 'summary' and 'render' modes is 'pending'. The options must be set explicitly for 'update' mode.

The type 'blocking' is reserved for commits needing further review.

--status|-s STATUS

For 'update' mode only, sets a new status. While there is no restriction, it should be one of 'new', 'pending', 'blocking', 'ignored' or 'done'.

--since REVISION

Defines the boundary for searching git commits. Defaults to the last major tag (as would be given by 'git describe').

--help

Shows the manual.

TODO ^

It would be nice to make some of the structured sections smarter -- e.g. look at changed files in pod/* for Documentation section entries. Likewise it would be nice to collate them during the render phase -- e.g. cluster all platform-specific things properly.

AUTHOR ^

David Golden <dagolden@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2010 by David Golden.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: