Update help.

Author: nicholasdower

.release-notes

@@ -1 +1 @@
-- No changes
+- Update help and man page.

man/git-coauthor.1

@@ -1,10 +1,10 @@
-.TH GIT\-COAUTHOR 1 2024-02-29 6.1.0 Git\ Manual
+.TH GIT\-COAUTHOR 1 2023-02-29 6.1.0 Git\ Manual
 .SH NAME
 \fBgit\-coauthor\fR \- List, add or delete Git coauthors
 .SH SYNOPSIS
 \fBgit coauthor\fR [-d] [\fIalias \.\.\.\fR]
 .SH DESCRIPTION
-Manage coauthors on the HEAD commit using configured aliases.
+Git coauthor manages "Co-authored-by" lines on the HEAD commit\. Coauthors may be specified as name or email details from the repository's commit history or as aliases configured via Git config\.
 .SH OPTIONS
 .TP
 \fB\-d, \-\-delete\fR
@@ -16,42 +16,54 @@ Print help\.
 \fB\-v\, \-\-version\fR
 Print the version\.
 .SH CONFIGURATION
-Add a coauthor to the Git configuration:
+Optionally, coauthor aliases can be added to the Git config:
 .PP
 .RS 4
 .nf
-git config --add coauthor.foo 'Foo <foo@foo.com>'
+git config --add coauthor\.joe 'Joe Blow <foo@foo\.com>'
 .fi
 .RE
 .PP
-Remove a coauthor from the Git configuration:
+To remove a coauthor from the Git config:
 .PP
 .RS 4
 .nf
-git config --unset coauthor.foo
+git config --unset coauthor\.joe
 .fi
 .RE
 .SH EXAMPLES
 List coauthors on the HEAD commit:
 .PP
 .RS 4
+.nf
 git coauthor
+.fi
 .RE
 .PP
 Add coauthors to the HEAD commit:
 .PP
 .RS 4
-git coauthor foo bar
+.nf
+git coauthor Joe
+git coauthor Joe Jim
+git coauthor 'Joe Blow' 'Jim Bob'
+.fi
 .RE
 .PP
 Delete coauthors from the HEAD commit:
 .PP
 .RS 4
-git coauthor -d foo bar
+.nf
+git coauthor -d Joe
+git coauthor -d Joe Jim
+git coauthor -d 'Joe Blow' 'Jim Bob'
+.fi
 .RE
 .PP
 Delete all coauthors from the HEAD commit:
 .PP
 .RS 4
+.nf
 git coauthor -d
+.fi
 .RE

script/manpage.sh

@@ -21,7 +21,7 @@ cat << EOF > man/git-coauthor.1
 .SH SYNOPSIS
 \fBgit coauthor\fR [-d] [\fIalias \.\.\.\fR]
 .SH DESCRIPTION
-Manage coauthors on the HEAD commit using configured aliases.
+Git coauthor manages "Co-authored-by" lines on the HEAD commit\. Coauthors may be specified as name or email details from the repository's commit history or as aliases configured via Git config\.
 .SH OPTIONS
 .TP
 \fB\-d, \-\-delete\fR
@@ -33,43 +33,55 @@ Print help\.
 \fB\-v\, \-\-version\fR
 Print the version\.
 .SH CONFIGURATION
-Add a coauthor to the Git configuration:
+Optionally, coauthor aliases can be added to the Git config:
 .PP
 .RS 4
 .nf
-git config --add coauthor.foo 'Foo <foo@foo.com>'
+git config --add coauthor\.joe 'Joe Blow <foo@foo\.com>'
 .fi
 .RE
 .PP
-Remove a coauthor from the Git configuration:
+To remove a coauthor from the Git config:
 .PP
 .RS 4
 .nf
-git config --unset coauthor.foo
+git config --unset coauthor\.joe
 .fi
 .RE
 .SH EXAMPLES
 List coauthors on the HEAD commit:
 .PP
 .RS 4
+.nf
 git coauthor
+.fi
 .RE
 .PP
 Add coauthors to the HEAD commit:
 .PP
 .RS 4
-git coauthor foo bar
+.nf
+git coauthor Joe
+git coauthor Joe Jim
+git coauthor 'Joe Blow' 'Jim Bob'
+.fi
 .RE
 .PP
 Delete coauthors from the HEAD commit:
 .PP
 .RS 4
-git coauthor -d foo bar
+.nf
+git coauthor -d Joe
+git coauthor -d Joe Jim
+git coauthor -d 'Joe Blow' 'Jim Bob'
+.fi
 .RE
 .PP
 Delete all coauthors from the HEAD commit:
 .PP
 .RS 4
+.nf
 git coauthor -d
+.fi
 .RE
 EOF

src/main.rs

@@ -14,8 +14,8 @@ List, add or delete Git coauthors
 Description
 
     Git coauthor manages \"Co-authored-by\" lines on the HEAD commit. Coauthors
-    are specified as name or email details from the repository's commit history
-    or as aliases configured via `git config`.
+    may be specified as name or email details from the repository's commit history
+    or as aliases configured via Git config.
 
 Options
 
@@ -43,13 +43,13 @@ Examples
 
         git coauthor Joe
         git coauthor Joe Jim
-        git coauthor \"Joe Blow\" \"Jim Bob\"
+        git coauthor 'Joe Blow' 'Jim Bob'
 
     Delete coauthors from the HEAD commit:
 
         git coauthor -d Joe
         git coauthor -d Joe Jim
-        git coauthor -d \"Joe Blow\" \"Jim Bob\"
+        git coauthor -d 'Joe Blow' 'Jim Bob'
 
     Delete all coauthors from the HEAD commit: