summary refs log tree commit diff
path: root/bin/man1
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2021-09-10 17:10:15 -0400
committerJune McEnroe <june@causal.agency>2021-09-10 17:10:15 -0400
commitb29e2c22710b965ec942dcc33f0b26e08ad76b50 (patch)
treeb0c81e67a45d2fc58edf66cd47d271201202101c /bin/man1
parentDefer printing comment if line is blank or closing brace (diff)
downloadsrc-b29e2c22710b965ec942dcc33f0b26e08ad76b50.tar.gz
src-b29e2c22710b965ec942dcc33f0b26e08ad76b50.zip
Add git comment --pretty option
Diffstat (limited to 'bin/man1')
-rw-r--r--bin/man1/git-comment.131
1 files changed, 27 insertions, 4 deletions
diff --git a/bin/man1/git-comment.1 b/bin/man1/git-comment.1
index a981f839..8e958f30 100644
--- a/bin/man1/git-comment.1
+++ b/bin/man1/git-comment.1
@@ -1,4 +1,4 @@
-.Dd September  8, 2021
+.Dd September 10, 2021
 .Dt GIT-COMMENT 1
 .Os
 .
@@ -15,16 +15,26 @@
 .Op Fl \-min-group Ar lines
 .Op Fl \-min-repeat Ar lines
 .Op Fl \-no-repeat
+.Op Fl \-pretty Ar format
 .Op Ar options ...
 .Op Fl \-
 .Ar file
 .
 .Sh DESCRIPTION
-Annotates the given file with comments
-containing the commit messages
-of the revisions
+The
+.Nm
+command
+adds comments to a file
+showing the commit messages
 which last modified
 each group of lines.
+By default only commit messages with bodies
+and which modified groups of at least 2 lines
+are added.
+Each comment contains
+the abbreviated commit hash
+and the commit summary,
+followed by the commit body.
 .
 .Pp
 .Nm
@@ -75,6 +85,16 @@ The default is 30 lines.
 .
 .It Fl \-no-repeat
 Avoid repeating comments entirely.
+.
+.It Fl \-pretty Ar format
+Set the pretty-print format
+to use for commit messages.
+The default is the value of
+.Cm comment.pretty
+or
+.Ql format:%h\ %s%n%n%-b .
+See
+.Xr git-show 1 .
 .El
 .
 .Sh EXAMPLES
@@ -92,3 +112,6 @@ Add as many comments as possible:
 .Bd -literal -offset indent
 git comment --all --min-group 1 --min-repeat 1
 .Ed
+.
+.Sh SEE ALSO
+.Xr git-blame 1