git-standup: also update the docs

This commit is contained in:
spacewander 2017-04-13 00:03:19 +08:00
parent 684d6acc93
commit 0a125edeaf
4 changed files with 119 additions and 31 deletions

View file

@ -1109,9 +1109,9 @@ Commit: Jack <jack@work.com>
## git standup
Recall what you did or find what someone else did in a given range of time.
For instance, recall John's commits since last week:
For instance, recall John's commits since last week(7 days ago):
```
git standup John "last week"
git standup -a John -d 7
```
## git touch

View file

@ -1,34 +1,70 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-STANDUP" "1" "April 2016" "" ""
.TH "GIT\-STANDUP" "1" "April 2017" "" ""
.
.SH "NAME"
\fBgit\-standup\fR \- Recall the commit history
.
.SH "SYNOPSIS"
\fBgit\-standup\fR [<full name>] [<since>] [<until>]
\fBgit\-standup\fR [\-a author] [\-m depth] [\-d days ago] [\-D date format] [\-g] [\-L] [\-f]
.
.P
\fBgit\-standup\fR \-h
.
.SH "DESCRIPTION"
Recall what you did on the last working day \.\.or be nosy and find what someone else did\.
.
.SH "OPTIONS"
<full name>
\-a author
.
.P
The author of commits\. Defaults to \fB$(git config user\.name)\fR\.
The author of commits\. Use "all" means specifying "all authors"\. Defaults to \fB$(git config user\.name)\fR\.
.
.P
<since>
\-m depth
.
.P
The start of commit history\. Defaults to \fByesterday\fR\.
The depth of recursive directory search\. Defaults to 1\.
.
.P
<until>
\-L
.
.P
The end of commit history\. Defaults to \fBtoday\fR\.
Enable the inclusion of symbolic links in recursive directory search\.
.
.P
\-d 1
.
.P
The start of commit history\. Defaults to 1, means "1 days ago"\.
.
.P
\-D relative
.
.P
The date format displayed in commit history\. Defaults to "relative"\.
.
.P
\-h
.
.P
Display help message\.
.
.P
\-g
.
.P
Display if commit is GPG signed (G) or not (N) in commit message\.
.
.P
\-f
.
.P
Fetch the latest commits before showing commit history\.
.
.P
The former version of \fBgit standup\fR accepted \fB<author> <since> <until>\fR as options\. This interface is deprecated now, and please avoid to use it!
.
.SH "EXAMPLES"
This shows your commits since yesterday:
@ -52,7 +88,7 @@ This shows the author\'s commits since last week:
.
.nf
$ git standup spacewander "last week"
$ git standup \-a spacewander \-d 7
a26d1f9 \- add profile hook (70 minutes ago) <spacewander>
4e19859 \- fix getTotalSize return value error (6 days ago) <spacewander>
@ -72,7 +108,7 @@ If current directory is not a git repo, git\-standup will fetch data from all to
.nf
$ cd \.\.
$ git standup spacewander "last week" yesterday
$ git standup \-a spacewander \-d 7
someProject/
4e19859 \- fix getTotalSize return value error (6 days ago) <spacewander>

View file

@ -76,7 +76,9 @@
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>git-standup</code> [&lt;full name&gt;] [&lt;since&gt;] [&lt;until&gt;]</p>
<p><code>git-standup</code> [-a author] [-m depth] [-d days ago] [-D date format] [-g] [-L] [-f]</p>
<p><code>git-standup</code> -h</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
@ -84,17 +86,41 @@
<h2 id="OPTIONS">OPTIONS</h2>
<p>&lt;full name&gt;</p>
<p>-a author</p>
<p>The author of commits. Defaults to <code>$(git config user.name)</code>.</p>
<p>The author of commits. Use "all" means specifying "all authors".
Defaults to <code>$(git config user.name)</code>.</p>
<p>&lt;since&gt;</p>
<p>-m depth</p>
<p>The start of commit history. Defaults to <code>yesterday</code>.</p>
<p>The depth of recursive directory search. Defaults to 1.</p>
<p>&lt;until&gt;</p>
<p>-L</p>
<p>The end of commit history. Defaults to <code>today</code>.</p>
<p>Enable the inclusion of symbolic links in recursive directory search.</p>
<p>-d 1</p>
<p>The start of commit history. Defaults to 1, means "1 days ago".</p>
<p>-D relative</p>
<p>The date format displayed in commit history. Defaults to "relative".</p>
<p>-h</p>
<p>Display help message.</p>
<p>-g</p>
<p>Display if commit is GPG signed (G) or not (N) in commit message.</p>
<p>-f</p>
<p>Fetch the latest commits before showing commit history.</p>
<p>The former version of <code>git standup</code> accepted <code>&lt;author> &lt;since> &lt;until></code> as options.
This interface is deprecated now, and please avoid to use it!</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
@ -107,7 +133,7 @@ a26d1f9 - add profile hook (69 minutes ago) &lt;spacewander>
<p>This shows the author's commits since last week:</p>
<pre><code>$ git standup spacewander "last week"
<pre><code>$ git standup -a spacewander -d 7
a26d1f9 - add profile hook (70 minutes ago) &lt;spacewander>
4e19859 - fix getTotalSize return value error (6 days ago) &lt;spacewander>
@ -119,7 +145,7 @@ a26d1f9 - add profile hook (70 minutes ago) &lt;spacewander>
<p>If current directory is not a git repo, git-standup will fetch data from all top-level git repos under it:</p>
<pre><code>$ cd ..
$ git standup spacewander "last week" yesterday
$ git standup -a spacewander -d 7
someProject/
4e19859 - fix getTotalSize return value error (6 days ago) &lt;spacewander>
@ -143,7 +169,7 @@ someProject/
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>April 2016</li>
<li class='tc'>April 2017</li>
<li class='tr'>git-standup(1)</li>
</ol>

View file

@ -3,7 +3,9 @@ git-standup(1) -- Recall the commit history
## SYNOPSIS
`git-standup` [&lt;full name&gt;] [&lt;since&gt;] [&lt;until&gt;]
`git-standup` [-a author] [-m depth] [-d days ago] [-D date format] [-g] [-L] [-f]
`git-standup` -h
## DESCRIPTION
@ -11,17 +13,41 @@ Recall what you did on the last working day ..or be nosy and find what someone e
## OPTIONS
&lt;full name&gt;
-a author
The author of commits. Defaults to `$(git config user.name)`.
The author of commits. Use "all" means specifying "all authors".
Defaults to `$(git config user.name)`.
&lt;since&gt;
-m depth
The start of commit history. Defaults to `yesterday`.
The depth of recursive directory search. Defaults to 1.
&lt;until&gt;
-L
The end of commit history. Defaults to `today`.
Enable the inclusion of symbolic links in recursive directory search.
-d 1
The start of commit history. Defaults to 1, means "1 days ago".
-D relative
The date format displayed in commit history. Defaults to "relative".
-h
Display help message.
-g
Display if commit is GPG signed (G) or not (N) in commit message.
-f
Fetch the latest commits before showing commit history.
The former version of `git standup` accepted `<author> <since> <until>` as options.
This interface is deprecated now, and please avoid to use it!
## EXAMPLES
@ -33,7 +59,7 @@ This shows your commits since yesterday:
This shows the author's commits since last week:
$ git standup spacewander "last week"
$ git standup -a spacewander -d 7
a26d1f9 - add profile hook (70 minutes ago) <spacewander>
4e19859 - fix getTotalSize return value error (6 days ago) <spacewander>
@ -44,7 +70,7 @@ This shows the author's commits since last week:
If current directory is not a git repo, git-standup will fetch data from all top-level git repos under it:
$ cd ..
$ git standup spacewander "last week" yesterday
$ git standup -a spacewander -d 7
someProject/
4e19859 - fix getTotalSize return value error (6 days ago) <spacewander>