Skip to content

Commit

Permalink
doc(git-authors): update doc of the git-authors
Browse files Browse the repository at this point in the history
  • Loading branch information
vanpipy committed Oct 31, 2023
1 parent 795d048 commit 78721e2
Show file tree
Hide file tree
Showing 3 changed files with 133 additions and 67 deletions.
74 changes: 33 additions & 41 deletions man/git-authors.1
Original file line number Diff line number Diff line change
@@ -1,87 +1,79 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-AUTHORS" "1" "October 2017" "" "Git Extras"
.
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GIT\-AUTHORS" "1" "October 2023" "" "Git Extras"
.SH "NAME"
\fBgit\-authors\fR \- Generate authors report
.
.SH "SYNOPSIS"
\fBgit\-authors\fR [\-l, \-\-list] [\-\-no\-email]
.
\fBgit\-authors\fR \fBgit\-authors\fR [\-l, \-\-list] [\-\-no\-email] \fBgit\-authors\fR [\-\-output] <filename> [\-\-no\-email]
.SH "DESCRIPTION"
Populates the file matching \fIauthors|contributors \-i\fR with the authors of commits, according to the number of commits per author\. Opens the file in \fB$EDITOR\fR when set\.
.
.P
See the "MAPPING AUTHORS" section of \fBgit\-shortlog\fR(1) to coalesce together commits by the same person\.
.
.SH "OPTIONS"
\-l, \-\-list
.
.P
Show authors\.
.
.P
\-\-no\-email
.
.P
Don\'t show authors\' email\.
.
.P
\-\-output
.P
output the authors
.P
<filename>
.P
the filename to save the authors
.SH "EXAMPLES"
.
.TP
.IP "\[ci]" 4
Updating AUTHORS file:
.
.IP
$ git authors
.
.TP
.IP "\[ci]" 4
Listing authors:
.
.IP
$ git authors \-\-list
.
.IP
\fBTJ Holowaychuk <tj@vision\-media\.ca> hemanth\.hm <hemanth\.hm@gmail\.com> Jonhnny Weslley <jw@jonhnnyweslley\.net> nickl\- <github@jigsoft\.co\.za> Leila Muhtasib <muhtasib@gmail\.com>\fR
.IP "\[ci]" 4
Listing authors without email:
.IP
$ git authors \-\-list \-\-no\-email
.IP
\fBTJ Holowaychuk hemanth\.hm Jonhnny Weslley nickl\- Leila Muhtasib\fR
.IP "\[ci]" 4
Output authors
.IP "" 0
.P
$ git authors \-\-output authors_history
.IP "" 4
.
.nf

```authors_history
TJ Holowaychuk <tj@vision\-media\.ca>
hemanth\.hm <hemanth\.hm@gmail\.com>
Jonhnny Weslley <jw@jonhnnyweslley\.net>
nickl\- <github@jigsoft\.co\.za>
Leila Muhtasib <muhtasib@gmail\.com>
.
```
.fi
.
.IP "" 0

.
.TP
Listing authors without email:
.
.IP
$ git authors \-\-list \-\-no\-email
.
.P
$ git authors \-\-output authors_history \-\-no\-email
.IP "" 4
.
.nf

```authors_history
TJ Holowaychuk
hemanth\.hm
Jonhnny Weslley
nickl\-
Leila Muhtasib
.
```
.fi
.
.IP "" 0

.
.SH "AUTHOR"
Written by Titus Wormer <\fItituswormer@gmail\.com\fR>
.
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>
94 changes: 68 additions & 26 deletions man/git-authors.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 32 additions & 0 deletions man/git-authors.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ git-authors(1) -- Generate authors report

## SYNOPSIS

`git-authors`
`git-authors` [-l, --list] [--no-email]
`git-authors` [--output] &lt;filename&gt; [--no-email]

## DESCRIPTION

Expand All @@ -22,6 +24,14 @@ git-authors(1) -- Generate authors report

Don't show authors' email.

--output

output the authors

&lt;filename&gt;

the filename to save the authors

## EXAMPLES

* Updating AUTHORS file:
Expand Down Expand Up @@ -52,6 +62,28 @@ git-authors(1) -- Generate authors report
Leila Muhtasib
```
* Output authors
$ git authors --output authors_history
```authors_history
TJ Holowaychuk <[email protected]>
hemanth.hm <[email protected]>
Jonhnny Weslley <[email protected]>
nickl- <[email protected]>
Leila Muhtasib <[email protected]>
```
$ git authors --output authors_history --no-email
```authors_history
TJ Holowaychuk
hemanth.hm
Jonhnny Weslley
nickl-
Leila Muhtasib
```
## AUTHOR
Written by Titus Wormer &lt;<[email protected]>&gt;
Expand Down

0 comments on commit 78721e2

Please sign in to comment.