From ffa33879383147e41eca708448ffac4727054e1e Mon Sep 17 00:00:00 2001 From: "C. McEnroe" Date: Wed, 8 Sep 2021 21:58:07 -0400 Subject: Document and install git-comment --- bin/man1/git-comment.1 | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 bin/man1/git-comment.1 (limited to 'bin/man1') diff --git a/bin/man1/git-comment.1 b/bin/man1/git-comment.1 new file mode 100644 index 00000000..9c9b4cd6 --- /dev/null +++ b/bin/man1/git-comment.1 @@ -0,0 +1,88 @@ +.Dd September 8, 2021 +.Dt GIT-COMMENT 1 +.Os +. +.Sh NAME +.Nm git-comment +.Nd add comments from commit messages +. +.Sh SYNOPSIS +.Nm git comment +.Op Fl \-all +.Op Fl \-comment-start Ar string +.Op Fl \-comment-lead Ar string +.Op Fl \-comment-end Ar string +.Op Fl \-min-group Ar lines +.Op Fl \-min-repeat Ar lines +.Op Fl \-no-repeat +.Op Ar options ... +.Op Fl \- +.Ar file +. +.Sh DESCRIPTION +Annotates the given file with comments +containing the commit messages +of the revisions +which last modified +each group of lines. +. +.Pp +.Nm +accepts all the options of +.Xr git-blame 1 +in addition to the following: +.Bl -tag -width Ds +.It Fl \-all +Include all commit messages. +The default is to include +only commit messages with bodies +(lines after the summary). +. +.It Fl \-comment-start Ar string +Start comments with +.Ar string . +The default is the value of +.Cm comment.start +or +.Ql /* . +. +.It Fl \-comment-lead Ar string +Continue comments with the leading +.Ar string . +The default is the value of +.Cm comment.lead +or +.Ql " *" . +. +.It Fl \-comment-end Ar string +End comments with +.Ar string . +The default is the value of +.Cm comment.end +or +.Ql " */" . +. +.It Fl \-min-group Ar lines +Add comments only for groups of at least +.Ar lines . +The default is 2 lines. +. +.It Fl \-min-repeat Ar lines +Avoid repeating a comment +if it occurred in the last +.Ar lines . +The default is 20 lines. +. +.It Fl \-no-repeat +Avoid repeating comments entirely. +.El +. +.Sh EXAMPLES +For files with +.Ql # +comments: +.Bd -literal -offset indent +git config comment.start '#' +git config comment.lead '#' +git config comment.end '' +.Ed -- cgit 1.4.1 ollow=1'>.local/bin/def (unfollow)
Commit message (Expand)Author
2020-06-08Add additional permission for linking with LibreSSLJune McEnroe
2020-06-08Replace __DECONST with regular castsJune McEnroe
2020-06-08Replace __printflike with __attribute__((format(printf, ...)))June McEnroe
2020-06-08Replace __dead2 with __attribute__((noreturn))June McEnroe
2020-06-08Replace __FBSDID macros with commentsJune McEnroe
2020-06-08Remove reference to FreeBSD-specific libedit hackJune McEnroe
2020-06-08Prefix mandoc with exec in about-filterJune McEnroe
2020-06-07Remove mktemp options from mkbuiltins, mktokensJune McEnroe
2020-06-07Cast z_stream fields to size_tJune McEnroe
2020-06-07Call static_assert by _Static_assertJune McEnroe
2020-06-07Add OpenBSD to install.shJune McEnroe
2020-06-03Add The Song of AchillesJune McEnroe
2020-06-01Allow redirecting input in everJune McEnroe
2020-05-31Add %c conversion to c scriptJune McEnroe
2020-05-31Add c script to READMEJune McEnroe
2020-05-31Add c scriptJune McEnroe
2020-05-31Update mdoc source URLsJune McEnroe
2020-05-26Remove unfinished PSF fontsJune McEnroe