From 0a125edeaf3827de451d4ae75ed5dd74f4858847 Mon Sep 17 00:00:00 2001 From: spacewander Date: Thu, 13 Apr 2017 00:03:19 +0800 Subject: [PATCH] git-standup: also update the docs --- Commands.md | 4 ++-- man/git-standup.1 | 56 ++++++++++++++++++++++++++++++++++++-------- man/git-standup.html | 46 ++++++++++++++++++++++++++++-------- man/git-standup.md | 44 +++++++++++++++++++++++++++------- 4 files changed, 119 insertions(+), 31 deletions(-) diff --git a/Commands.md b/Commands.md index 8c9f2b8..6bfce20 100644 --- a/Commands.md +++ b/Commands.md @@ -1109,9 +1109,9 @@ Commit: Jack ## 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 diff --git a/man/git-standup.1 b/man/git-standup.1 index 9a30648..210d21f 100644 --- a/man/git-standup.1 +++ b/man/git-standup.1 @@ -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 [] [] [] +\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" - +\-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 - +\-m depth . .P -The start of commit history\. Defaults to \fByesterday\fR\. +The depth of recursive directory search\. Defaults to 1\. . .P - +\-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 \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) 4e19859 \- fix getTotalSize return value error (6 days ago) @@ -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) diff --git a/man/git-standup.html b/man/git-standup.html index 938ac2c..fb20191 100644 --- a/man/git-standup.html +++ b/man/git-standup.html @@ -76,7 +76,9 @@

SYNOPSIS

-

git-standup [<full name>] [<since>] [<until>]

+

git-standup [-a author] [-m depth] [-d days ago] [-D date format] [-g] [-L] [-f]

+ +

git-standup -h

DESCRIPTION

@@ -84,17 +86,41 @@

OPTIONS

-

<full name>

+

-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).

-

<since>

+

-m depth

-

The start of commit history. Defaults to yesterday.

+

The depth of recursive directory search. Defaults to 1.

-

<until>

+

-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

@@ -107,7 +133,7 @@ a26d1f9 - add profile hook (69 minutes ago) <spacewander>

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>
@@ -119,7 +145,7 @@ a26d1f9 - add profile hook (70 minutes ago) <spacewander>
 
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>
@@ -143,7 +169,7 @@ someProject/
 
   
    
     
  1. 
-    
  2. April 2016
    3. 
+    
  3. April 2017
    4. 
     
  4. git-standup(1)
    5. 
   

 
diff --git a/man/git-standup.md b/man/git-standup.md
index 57ec3ea..8f70567 100644
--- a/man/git-standup.md
+++ b/man/git-standup.md
@@ -3,7 +3,9 @@ git-standup(1) -- Recall the commit history
 
 ## SYNOPSIS
 
-`git-standup` [<full name>] [<since>] [<until>]
+`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
 
-<full name>
+-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)`.
 
-<since>
+-m depth
 
-The start of commit history. Defaults to `yesterday`.
+The depth of recursive directory search. Defaults to 1.
 
-<until>
+-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 `  ` 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) 
     4e19859 - fix getTotalSize return value error (6 days ago) 
@@ -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)