From b1c0ccc9afe38e48b1d2b704d1cacc9db4f90132 Mon Sep 17 00:00:00 2001
From: Mischa POSLAWSKY <perl@shiar.org>
Date: Fri, 4 Feb 2011 01:43:42 +0100
Subject: [PATCH] documentation and help options

---
 git-grep-footer | 94 ++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 86 insertions(+), 8 deletions(-)

diff --git a/git-grep-footer b/git-grep-footer
index 906ae92..ff279a6 100755
--- a/git-grep-footer
+++ b/git-grep-footer
@@ -5,7 +5,7 @@ use warnings;
 use open ':std', OUT => ':utf8';
 use Encode 'decode';
 use Data::Dump 'pp';
-use Getopt::Long;
+use Getopt::Long qw(:config bundling);
 
 GetOptions(\my %opt,
 	'debug!',
@@ -13,7 +13,10 @@ GetOptions(\my %opt,
 	'ignore-case|i!',
 	'min|min-count|unique|u:i',
 	'max|max-count|show|n:i',
-) or die;
+	'version|V'  => sub { Getopt::Long::VersionMessage() },
+	'usage|h'    => sub { Getopt::Long::HelpMessage() },
+	'help|man|?' => sub { Getopt::Long::HelpMessage(-verbose => 2) },
+) or exit 129;
 
 local $| = 1;
 local $/ = "\0";
@@ -56,16 +59,16 @@ while (readline) {
 
 			push @header, $_ if defined $opt{max};
 
-			given ($opt{simplify} // 'no') {
-				when ('strict') {
+			given ($opt{simplify} // 'none') {
+				when (['email', 'authors']) {
 					$header[1] =~ s{
 						\A
-						(?: [^:]+ )?
+						(?: [^:;]+ )?
 						< [^@>]+ (?: @ | \h?\W? at \W?\h? ) [a-z0-9.-]+ >
 						\Z
 					}{<...>}imsx;
 				}
-				when (['text', '']) {
+				when (['var', 'vars', '']) {
 					when ($header[0] =~ /[ _-] (?: by | to ) $/imsx) {
 						$header[1] = undef;
 					}
@@ -76,10 +79,10 @@ while (readline) {
 						s{\b I? [0-9a-f]{40} \b}{[sha1]}gmsx;  # hash
 					}
 				}
-				when (['all', 'any']) {
+				when (['all', 'contents']) {
 					$header[1] = undef;
 				}
-				when ('no') {
+				when (['none', 'no', '0']) {
 				}
 				default {
 					die "Unknown simplify option: '$_'\n";
@@ -114,3 +117,78 @@ while (readline) {
 		last BLOCK;
 	}
 }
+
+__END__
+
+=head1 NAME
+
+git-grep-footer - Find custom header lines in commit messages
+
+=head1 SYNOPSIS
+
+F<git> log --pretty=%b%x00 | F<git-grep-footer> [OPTIONS]
+
+=head1 DESCRIPTION
+
+Filters out header sections near the end of a commit body,
+a common convention to list custom metadata such as
+C<Signed-off-by> and C<Acked-by>.
+
+Sections are identified by at least one leading keyword containing a dash
+followed by a colon.
+
+=head1 OPTIONS
+
+=over
+
+=item -i, --ignore-case
+
+Lowercases everything.
+
+=item -s, --simplify[=<rule>]
+
+Modifies values to hide specific details.
+Several different rules are supported:
+
+=over
+
+=item I<var> (default)
+
+Replaces highly variable contents such as numbers, hashes, and addresses,
+leaving only exceptional annotations as distinct text.
+Attributes ending in I<-to> or I<-by> are assumed variable author names
+and omitted entirely,
+unless they contain a colon indicating possible attribute exceptions.
+
+=item I<email>
+
+Filters out author lines following the git signoff convention,
+i.e. an <email address> optionally preceded by a name.
+
+=item I<all>
+
+Values will be hidden entirely, so only attribute names remain.
+
+=back
+
+=item -u, --unique[=<threshold>]
+
+Each match is only shown once,
+optionally after it has already occurred a given amount of times.
+
+=item -n, --show[=<limit>]
+
+The original line is given for each match,
+but simplifications still apply for duplicate determination.
+Additional samples are optionally given upto the given maximum.
+
+=back
+
+=head1 AUTHOR
+
+Mischa POSLAWSKY <perl@shiar.org>
+
+=head1 LICENSE
+
+Copyright. All rights reserved.
+
-- 
2.30.0