Skip to content

Commit

Permalink
doc(git-authors): remove description of opening authors with the defa…
Browse files Browse the repository at this point in the history
…ult editor
  • Loading branch information
vanpipy committed Nov 11, 2023
1 parent c32ab5c commit 43b6134
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 82 deletions.
2 changes: 0 additions & 2 deletions Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -953,8 +953,6 @@ $ git squash HEAD~3 "Work on a feature"
Populates the file matching `authors|contributors -i` with the authors of commits, according to the number of commits per author.
Opens the file in `$EDITOR` when set.
See the ["MAPPING AUTHORS" section](https://git-scm.com/docs/git-shortlog#_mapping_authors) of **git-shortlog**(1) to coalesce together commits by the same person.
Updating AUTHORS file:
Expand Down
58 changes: 15 additions & 43 deletions man/git-authors.1
Original file line number Diff line number Diff line change
@@ -1,87 +1,59 @@
.\" 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" "November 2023" "" "Git Extras"
.SH "NAME"
\fBgit\-authors\fR \- Generate authors report
.
.SH "SYNOPSIS"
\fBgit\-authors\fR [\-l, \-\-list] [\-\-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\.
.
.TS
allbox;
Populates the file matching _authors contributors \-i_ with the authors of commits, according to the number of commits per author\.
.TE
.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\.
.
.SH "EXAMPLES"
.
.TP
Updating AUTHORS file:
.
.IP
.IP "" 4
.nf
$ git authors
.
.TP
.fi
.IP "" 0
.P
Listing authors:
.
.IP
$ git authors \-\-list
.
.IP "" 4
.
.nf

$ git authors \-\-list
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
.P
Listing authors without email:
.
.IP
$ git authors \-\-list \-\-no\-email
.
.IP "" 4
.
.nf

$ git authors \-\-list \-\-no\-email
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>
58 changes: 31 additions & 27 deletions man/git-authors.html

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

13 changes: 3 additions & 10 deletions man/git-authors.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ git-authors(1) -- Generate authors report
## DESCRIPTION

Populates the file matching _authors|contributors -i_ with the authors of commits, according to the number of commits per author.
Opens the file in **$EDITOR** when set.

See the "MAPPING AUTHORS" section of **git-shortlog**(1) to coalesce together commits by the same person.

Expand All @@ -24,33 +23,27 @@ git-authors(1) -- Generate authors report

## EXAMPLES

* Updating AUTHORS file:
Updating AUTHORS file:

$ git authors

* Listing authors:
Listing authors:

$ git authors --list

```
TJ Holowaychuk <[email protected]>
hemanth.hm <[email protected]>
Jonhnny Weslley <[email protected]>
nickl- <[email protected]>
Leila Muhtasib <[email protected]>
```

* Listing authors without email:
Listing authors without email:

$ git authors --list --no-email
```
TJ Holowaychuk
hemanth.hm
Jonhnny Weslley
nickl-
Leila Muhtasib
```

## AUTHOR

Expand Down

0 comments on commit 43b6134

Please sign in to comment.