Document git standup -w option

This commit is contained in:
Tobias Fendin 2022-04-26 15:24:43 +02:00
parent a73c19c14b
commit 4fcd233bf2
4 changed files with 21 additions and 9 deletions

View file

@ -5,7 +5,7 @@
usage() {
cat <<EOS
Usage:
git standup [-a <author name>] [-w <weekstart-weekend>] [-d <days-ago>] [-m <max-dir-depth>] [-g] [-h] [-f] [-B] [-n <number-of-commits]
git standup [-a <author name>] [-w <weekstart-weekend>|-d <days-ago>] [-m <max-dir-depth>] [-g] [-h] [-f] [-B] [-n <number-of-commits]
-a - Specify author to restrict search to, default to current git user.
Use "-a all" if you don't want the restriction.

View file

@ -1,10 +1,10 @@
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "GIT\-STANDUP" "1" "August 2021" "" "Git Extras"
.TH "GIT\-STANDUP" "1" "April 2022" "" "Git Extras"
.SH "NAME"
\fBgit\-standup\fR \- Recall the commit history
.SH "SYNOPSIS"
\fBgit\-standup\fR [\-a author] [\-m depth] [\-d days ago] [\-D date format] [\-g] [\-L] [\-f] [\-B] [\-n number of commits]
\fBgit\-standup\fR [\-a author] [\-w \fIweekstart\-weekend\fR|\-d \fIdays\-ago\fR] [\-m depth] [\-D date format] [\-g] [\-L] [\-f] [\-B] [\-n number of commits]
.br
\fBgit\-standup\fR \-h
.SH "DESCRIPTION"
@ -22,10 +22,14 @@ The depth of recursive directory search\. Defaults to 1\.
.P
Enable the inclusion of symbolic links in recursive directory search\.
.P
\-d 1
\-d days\-ago
.P
The start of commit history\. Defaults to 1, means "1 days ago"\.
.P
\-w \fIweekstart\-weekend\fR
.P
Limit the search range to weekdays\. If weekstart and/or weekend are missing they default to Mon and Fri\.
.P
\-D relative
.P
The date format displayed in commit history\. Defaults to "relative"\.

View file

@ -77,7 +77,7 @@
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>git-standup</code> [-a author] [-m depth] [-d days ago] [-D date format] [-g] [-L] [-f] [-B] [-n number of commits]<br>
<p><code>git-standup</code> [-a author] [-w <var>weekstart-weekend</var>|-d <var>days-ago</var>] [-m depth] [-D date format] [-g] [-L] [-f] [-B] [-n number of commits]<br>
<code>git-standup</code> -h</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
@ -99,10 +99,14 @@ Defaults to <code>$(git config user.name)</code>.</p>
<p>Enable the inclusion of symbolic links in recursive directory search.</p>
<p>-d 1</p>
<p>-d days-ago</p>
<p>The start of commit history. Defaults to 1, means "1 days ago".</p>
<p>-w <var>weekstart-weekend</var></p>
<p>Limit the search range to weekdays. If weekstart and/or weekend are missing they default to Mon and Fri.</p>
<p>-D relative</p>
<p>The date format displayed in commit history. Defaults to "relative".</p>
@ -198,7 +202,7 @@ master
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>August 2021</li>
<li class='tc'>April 2022</li>
<li class='tr'>git-standup(1)</li>
</ol>

View file

@ -3,7 +3,7 @@ git-standup(1) -- Recall the commit history
## SYNOPSIS
`git-standup` [-a author] [-m depth] [-d days ago] [-D date format] [-g] [-L] [-f] [-B] [-n number of commits]
`git-standup` [-a author] [-w <weekstart-weekend>|-d <days-ago>] [-m depth] [-D date format] [-g] [-L] [-f] [-B] [-n number of commits]
`git-standup` -h
## DESCRIPTION
@ -25,10 +25,14 @@ The depth of recursive directory search. Defaults to 1.
Enable the inclusion of symbolic links in recursive directory search.
-d 1
-d days-ago
The start of commit history. Defaults to 1, means "1 days ago".
-w <weekstart-weekend>
Limit the search range to weekdays. If weekstart and/or weekend are missing they default to Mon and Fri.
-D relative
The date format displayed in commit history. Defaults to "relative".