summaryrefslogtreecommitdiff
path: root/Porting/git-deltatool
diff options
context:
space:
mode:
authorDavid Golden <dagolden@cpan.org>2010-07-14 10:54:22 -0400
committerDavid Golden <dagolden@cpan.org>2010-07-14 10:54:22 -0400
commit549721043abcedfad93596c79e4d2947a12ce5ef (patch)
tree8d6dbfc71083bf0140a45e48664d19371587ba8f /Porting/git-deltatool
parent6f56ac39f60976727952f47f417ee5d00a7b359d (diff)
downloadperl-549721043abcedfad93596c79e4d2947a12ce5ef.tar.gz
Add help and fix doc typo for git-deltatool
Diffstat (limited to 'Porting/git-deltatool')
-rwxr-xr-xPorting/git-deltatool18
1 files changed, 13 insertions, 5 deletions
diff --git a/Porting/git-deltatool b/Porting/git-deltatool
index ac35441816..f3612f5058 100755
--- a/Porting/git-deltatool
+++ b/Porting/git-deltatool
@@ -15,6 +15,7 @@ use Getopt::Long;
use Git::Wrapper;
use Term::ReadKey;
use Term::ANSIColor;
+use Pod::Usage;
BEGIN { struct( git => '$', last_tag => '$', opt => '%' ) }
@@ -37,8 +38,11 @@ sub run {
'type|t:s', # select by status
'status|s:s', # status to set for 'update'
'since:s', # origin commit
+ 'help|h', # help
);
+ pod2usage() if $opt{help};
+
my $git = Git::Wrapper->new(".");
my $git_id = $opt{since};
if ( defined $git_id ) {
@@ -731,25 +735,25 @@ __END__
=head1 NAME
-git-deltatool.pl - Annotate commits for perldelta
+git-deltatool - Annotate commits for perldelta
=head1 SYNOPSIS
# annotate commits back to last 'git describe' tag
- $ git-deltatool.pl
+ $ git-deltatool
# review annotations
- $ git-deltatool.pl --mode review
+ $ git-deltatool --mode review
# summarize annotations by section to STDOUT
- $ git-deltatool.pl --mode render
+ $ git-deltatool --mode render
# mark 'pending' annotations as 'done' (i.e. added to perldelta)
- $ git-deltatool.pl --mode update --type pending --status done
+ $ git-deltatool --mode update --type pending --status done
=head1 OPTIONS
@@ -778,6 +782,10 @@ it should be one of 'new', 'pending', 'ignored' or 'done'.
Defines the boundary for searching git commits. Defaults to the last
major tag (as would be given by 'git describe').
+=item B<--help>
+
+Shows the manual.
+
=back
=head1 TODO