From 4dc76ef81ba423688d205a2b95f6f73b02e9dc8f Mon Sep 17 00:00:00 2001 From: Mark Pitman Date: Wed, 12 Jul 2017 00:53:44 -0700 Subject: [PATCH] Update man pages --- man/git-bug.1 | 18 ++++++++++++++++-- man/git-bug.html | 15 ++++++++++++--- man/git-bug.md | 13 +++++++++++-- man/git-chore.1 | 15 +++++++++++++-- man/git-chore.html | 13 ++++++++++--- man/git-chore.md | 11 +++++++++-- man/git-create-branch.1 | 19 ++++++++++++++++--- man/git-create-branch.html | 17 +++++++++++++---- man/git-create-branch.md | 15 ++++++++++++--- man/git-feature.1 | 15 +++++++++++++-- man/git-feature.html | 13 ++++++++++--- man/git-feature.md | 11 +++++++++-- man/git-refactor.1 | 15 +++++++++++++-- man/git-refactor.html | 13 ++++++++++--- man/git-refactor.md | 11 +++++++++-- 15 files changed, 176 insertions(+), 38 deletions(-) diff --git a/man/git-bug.1 b/man/git-bug.1 index bf3670a..6bc8966 100644 --- a/man/git-bug.1 +++ b/man/git-bug.1 @@ -1,24 +1,33 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-BUG" "1" "December 2015" "" "" +.TH "GIT\-BUG" "1" "July 2017" "" "" . .SH "NAME" \fBgit\-bug\fR \- Create bug branch . .SH "SYNOPSIS" -\fBgit\-bug\fR [finish] +\fBgit\-bug\fR [\-r|\-\-remote [remote_name]] [finish] . .SH "DESCRIPTION" Create the given bug branch . .SH "OPTIONS" +<\-r|\-\-remote [remote_name]> +. +.P +Setup a remote tracking branch using \fBremote_name\fR\. If \fBremote_name\fR is not supplied, use \fBorigin\fR by default\. +. +.P . .P Merge and delete the bug branch\. . .P +<\-r +. +.P . .P @@ -34,12 +43,17 @@ $ git commit \-m "Some changes" \.\.\. $ git checkout master $ git bug finish bug\-123456 + +$ git bug \-r 12345 . .fi . .SH "AUTHOR" Written by Jesús Espino <\fIjespinog@gmail\.com\fR> . +.br +Modified by Mark Pitman <\fImark\.pitman@gmail\.com\fR> +. .SH "REPORTING BUGS" <\fIhttps://github\.com/tj/git\-extras/issues\fR> . diff --git a/man/git-bug.html b/man/git-bug.html index b7c0917..64bd56f 100644 --- a/man/git-bug.html +++ b/man/git-bug.html @@ -76,7 +76,7 @@

SYNOPSIS

-

git-bug [finish] <name>

+

git-bug [-r|--remote [remote_name]] [finish] <name>

DESCRIPTION

@@ -84,10 +84,16 @@

OPTIONS

+

<-r|--remote [remote_name]>

+ +

Setup a remote tracking branch using remote_name. If remote_name is not supplied, use origin by default.

+

<finish>

Merge and delete the bug branch.

+

<-r

+

<name>

The name of the bug branch.

@@ -100,11 +106,14 @@ $ git commit -m "Some changes" ... $ git checkout master $ git bug finish bug-123456 + +$ git bug -r 12345

AUTHOR

-

Written by Jesús Espino <jespinog@gmail.com>

+

Written by Jesús Espino <jespinog@gmail.com>
+Modified by Mark Pitman <mark.pitman@gmail.com>

REPORTING BUGS

@@ -117,7 +126,7 @@ $ git bug finish bug-123456
  1. -
  2. December 2015
    3. +
  3. July 2017
  4. git-bug(1)
diff --git a/man/git-bug.md b/man/git-bug.md index 0a241d4..d6482e4 100644 --- a/man/git-bug.md +++ b/man/git-bug.md @@ -3,7 +3,7 @@ git-bug(1) -- Create bug branch ## SYNOPSIS -`git-bug` [finish] <name> +`git-bug` [-r|--remote [remote_name]] [finish] <name> ## DESCRIPTION @@ -11,10 +11,16 @@ git-bug(1) -- Create bug branch ## OPTIONS + <-r|--remote [remote_name]> + + Setup a remote tracking branch using `remote_name`. If `remote_name` is not supplied, use `origin` by default. + <finish> Merge and delete the bug branch. + <-r + <name> The name of the bug branch. @@ -28,9 +34,12 @@ git-bug(1) -- Create bug branch $ git checkout master $ git bug finish bug-123456 + $ git bug -r 12345 + ## AUTHOR -Written by Jesús Espino <> +Written by Jesús Espino <> +Modified by Mark Pitman <> ## REPORTING BUGS diff --git a/man/git-chore.1 b/man/git-chore.1 index 9e169f4..25ca64f 100644 --- a/man/git-chore.1 +++ b/man/git-chore.1 @@ -1,18 +1,24 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-CHORE" "1" "December 2015" "" "" +.TH "GIT\-CHORE" "1" "July 2017" "" "" . .SH "NAME" \fBgit\-chore\fR \- Create chore branch . .SH "SYNOPSIS" -\fBgit\-chore\fR [finish] +\fBgit\-chore\fR [\-r|\-\-remote [remote_name]] [finish] . .SH "DESCRIPTION" Create the given chore branch . .SH "OPTIONS" +<\-r|\-\-remote [remote_name]> +. +.P +Setup a remote tracking branch using \fBremote_name\fR\. If \fBremote_name\fR is not supplied, use \fBorigin\fR by default\. +. +.P . .P @@ -34,12 +40,17 @@ $ git commit \-m "Some changes" \.\.\. $ git checkout master $ git chore finish chore\-123456 + +$ git chore \-r upstream 123456 . .fi . .SH "AUTHOR" Written by Chris Hall <\fIchristopher\.k\.hall@gmail\.com\fR> from bug/feature/refactor commands originally written by Jesús Espino <\fIjespinog@gmail\.com\fR> . +.br +Modified by Mark Pitman <\fImark\.pitman@gmail\.com\fR> +. .SH "REPORTING BUGS" <\fIhttps://github\.com/tj/git\-extras/issues\fR> . diff --git a/man/git-chore.html b/man/git-chore.html index 2da85e3..f41c6a5 100644 --- a/man/git-chore.html +++ b/man/git-chore.html @@ -76,7 +76,7 @@

SYNOPSIS

-

git-chore [finish] <name>

+

git-chore [-r|--remote [remote_name]] [finish] <name>

DESCRIPTION

@@ -84,6 +84,10 @@

OPTIONS

+

<-r|--remote [remote_name]>

+ +

Setup a remote tracking branch using remote_name. If remote_name is not supplied, use origin by default.

+

<finish>

Merge and delete the chore branch.

@@ -100,11 +104,14 @@ $ git commit -m "Some changes" ... $ git checkout master $ git chore finish chore-123456 + +$ git chore -r upstream 123456

AUTHOR

-

Written by Chris Hall <christopher.k.hall@gmail.com> from bug/feature/refactor commands originally written by Jesús Espino <jespinog@gmail.com>

+

Written by Chris Hall <christopher.k.hall@gmail.com> from bug/feature/refactor commands originally written by Jesús Espino <jespinog@gmail.com>
+Modified by Mark Pitman <mark.pitman@gmail.com>

REPORTING BUGS

@@ -117,7 +124,7 @@ $ git chore finish chore-123456
  1. -
  2. December 2015
    3. +
  3. July 2017
  4. git-chore(1)
diff --git a/man/git-chore.md b/man/git-chore.md index eb13fa5..4202d49 100644 --- a/man/git-chore.md +++ b/man/git-chore.md @@ -3,7 +3,7 @@ git-chore(1) -- Create chore branch ## SYNOPSIS -`git-chore` [finish] <name> +`git-chore` [-r|--remote [remote_name]] [finish] <name> ## DESCRIPTION @@ -11,6 +11,10 @@ git-chore(1) -- Create chore branch ## OPTIONS + <-r|--remote [remote_name]> + + Setup a remote tracking branch using `remote_name`. If `remote_name` is not supplied, use `origin` by default. + <finish> Merge and delete the chore branch. @@ -28,9 +32,12 @@ git-chore(1) -- Create chore branch $ git checkout master $ git chore finish chore-123456 + $ git chore -r upstream 123456 + ## AUTHOR -Written by Chris Hall <> from bug/feature/refactor commands originally written by Jesús Espino <> +Written by Chris Hall <> from bug/feature/refactor commands originally written by Jesús Espino <> +Modified by Mark Pitman <> ## REPORTING BUGS diff --git a/man/git-create-branch.1 b/man/git-create-branch.1 index 00d6903..086aa17 100644 --- a/man/git-create-branch.1 +++ b/man/git-create-branch.1 @@ -1,18 +1,24 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-CREATE\-BRANCH" "1" "December 2015" "" "" +.TH "GIT\-CREATE\-BRANCH" "1" "July 2017" "" "" . .SH "NAME" \fBgit\-create\-branch\fR \- Create branches . .SH "SYNOPSIS" -\fBgit\-create\-branch\fR +\fBgit\-create\-branch\fR [\-r|\-\-remote [remote_name]] . .SH "DESCRIPTION" -Creates local and remote branch named \. +Creates local branch named and optionally sets up a remote tracking branch\. . .SH "OPTIONS" +<\-r|\-\-remote [remote_name]> +. +.P +Setup a remote tracking branch using \fBremote_name\fR\. If \fBremote_name\fR is not supplied, use \fBorigin\fR by default\. +. +.P . .P @@ -23,12 +29,19 @@ The name of the branch to create\. .nf $ git create\-branch integration + +$ git create\-branch \-r integration + +$ git create\-branch \-r upstream integration . .fi . .SH "AUTHOR" Written by Jonhnny Weslley <\fIjw@jonhnnyweslley\.net\fR> . +.br +Modified by Mark Pitman <\fImark\.pitman@gmail\.com\fR> +. .SH "REPORTING BUGS" <\fIhttps://github\.com/tj/git\-extras/issues\fR> . diff --git a/man/git-create-branch.html b/man/git-create-branch.html index 9b91c4d..9bc0239 100644 --- a/man/git-create-branch.html +++ b/man/git-create-branch.html @@ -76,14 +76,18 @@

SYNOPSIS

-

git-create-branch <branchname>

+

git-create-branch [-r|--remote [remote_name]] <branchname>

DESCRIPTION

-

Creates local and remote branch named <branchname>.

+

Creates local branch named <branchname> and optionally sets up a remote tracking branch.

OPTIONS

+

<-r|--remote [remote_name]>

+ +

Setup a remote tracking branch using remote_name. If remote_name is not supplied, use origin by default.

+

<branchname>

The name of the branch to create.

@@ -91,11 +95,16 @@

EXAMPLES

$ git create-branch integration
+
+$ git create-branch -r integration
+
+$ git create-branch -r upstream integration

AUTHOR

-

Written by Jonhnny Weslley <jw@jonhnnyweslley.net>

+

Written by Jonhnny Weslley <jw@jonhnnyweslley.net>
+Modified by Mark Pitman <mark.pitman@gmail.com>

REPORTING BUGS

@@ -108,7 +117,7 @@
  1. -
  2. December 2015
    3. +
  3. July 2017
  4. git-create-branch(1)
diff --git a/man/git-create-branch.md b/man/git-create-branch.md index 029bf27..98b15ae 100644 --- a/man/git-create-branch.md +++ b/man/git-create-branch.md @@ -3,14 +3,18 @@ git-create-branch(1) -- Create branches ## SYNOPSIS -`git-create-branch` <branchname> +`git-create-branch` [-r|--remote [remote_name]] <branchname> ## DESCRIPTION - Creates local and remote branch named <branchname>. + Creates local branch named <branchname> and optionally sets up a remote tracking branch. ## OPTIONS + <-r|--remote [remote_name]> + + Setup a remote tracking branch using `remote_name`. If `remote_name` is not supplied, use `origin` by default. + <branchname> The name of the branch to create. @@ -19,9 +23,14 @@ git-create-branch(1) -- Create branches $ git create-branch integration + $ git create-branch -r integration + + $ git create-branch -r upstream integration + ## AUTHOR -Written by Jonhnny Weslley <> +Written by Jonhnny Weslley <> +Modified by Mark Pitman <> ## REPORTING BUGS diff --git a/man/git-feature.1 b/man/git-feature.1 index 1f3291f..7c39fdc 100644 --- a/man/git-feature.1 +++ b/man/git-feature.1 @@ -1,13 +1,13 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-FEATURE" "1" "December 2015" "" "" +.TH "GIT\-FEATURE" "1" "July 2017" "" "" . .SH "NAME" \fBgit\-feature\fR \- Create/Merge feature branch . .SH "SYNOPSIS" -\fBgit\-feature\fR [\-a|\-\-alias branch_prefix] [finish] +\fBgit\-feature\fR [\-a|\-\-alias branch_prefix] [\-r|\-\-remote [remote_name]] [finish] . .SH "DESCRIPTION" Create/Merge the given feature branch @@ -19,6 +19,12 @@ Create/Merge the given feature branch use \fBbranch_prefix\fR instead of \fBfeature\fR . .P +<\-r|\-\-remote [remote_name]> +. +.P +Setup a remote tracking branch using \fBremote_name\fR\. If \fBremote_name\fR is not supplied, use \fBorigin\fR by default\. +. +.P . .P @@ -46,12 +52,17 @@ $ git features dependencies $ (features/dependencies) \.\.\. $ (features/dependencies) git checkout master $ git features finish dependencies + +$ git feature dependencies \-r upstream . .fi . .SH "AUTHOR" Written by Jesús Espino <\fIjespinog@gmail\.com\fR> . +.br +Modified by Mark Pitman <\fImark\.pitman@gmail\.com\fR> +. .SH "REPORTING BUGS" <\fIhttps://github\.com/tj/git\-extras/issues\fR> . diff --git a/man/git-feature.html b/man/git-feature.html index 0374e9e..d614bb2 100644 --- a/man/git-feature.html +++ b/man/git-feature.html @@ -76,7 +76,7 @@

SYNOPSIS

-

git-feature [-a|--alias branch_prefix] [finish] <name>

+

git-feature [-a|--alias branch_prefix] [-r|--remote [remote_name]] [finish] <name>

DESCRIPTION

@@ -88,6 +88,10 @@

use branch_prefix instead of feature

+

<-r|--remote [remote_name]>

+ +

Setup a remote tracking branch using remote_name. If remote_name is not supplied, use origin by default.

+

<finish>

Merge and delete the feature branch.

@@ -110,11 +114,14 @@ $ git features dependencies $ (features/dependencies) ... $ (features/dependencies) git checkout master $ git features finish dependencies + +$ git feature dependencies -r upstream

AUTHOR

-

Written by Jesús Espino <jespinog@gmail.com>

+

Written by Jesús Espino <jespinog@gmail.com>
+Modified by Mark Pitman <mark.pitman@gmail.com>

REPORTING BUGS

@@ -127,7 +134,7 @@ $ git features finish dependencies
  1. -
  2. December 2015
    3. +
  3. July 2017
  4. git-feature(1)
diff --git a/man/git-feature.md b/man/git-feature.md index 0c78c9c..44a1b19 100644 --- a/man/git-feature.md +++ b/man/git-feature.md @@ -3,7 +3,7 @@ git-feature(1) -- Create/Merge feature branch ## SYNOPSIS -`git-feature` [-a|--alias branch_prefix] [finish] <name> +`git-feature` [-a|--alias branch_prefix] [-r|--remote [remote_name]] [finish] <name> ## DESCRIPTION @@ -15,6 +15,10 @@ git-feature(1) -- Create/Merge feature branch use `branch_prefix` instead of `feature` + <-r|--remote [remote_name]> + + Setup a remote tracking branch using `remote_name`. If `remote_name` is not supplied, use `origin` by default. + <finish> Merge and delete the feature branch. @@ -38,9 +42,12 @@ git-feature(1) -- Create/Merge feature branch $ (features/dependencies) git checkout master $ git features finish dependencies + $ git feature dependencies -r upstream + ## AUTHOR -Written by Jesús Espino <> +Written by Jesús Espino <> +Modified by Mark Pitman <> ## REPORTING BUGS diff --git a/man/git-refactor.1 b/man/git-refactor.1 index 6c14de0..cf0556d 100644 --- a/man/git-refactor.1 +++ b/man/git-refactor.1 @@ -1,18 +1,24 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-REFACTOR" "1" "December 2015" "" "" +.TH "GIT\-REFACTOR" "1" "July 2017" "" "" . .SH "NAME" \fBgit\-refactor\fR \- Create refactor branch . .SH "SYNOPSIS" -\fBgit\-refactor\fR [finish] +\fBgit\-refactor\fR [\-r|\-\-remote [remote_name]] [finish] . .SH "DESCRIPTION" Create the given refactor branch . .SH "OPTIONS" +<\-r|\-\-remote [remote_name]> +. +.P +Setup a remote tracking branch using \fBremote_name\fR\. If \fBremote_name\fR is not supplied, use \fBorigin\fR by default\. +. +.P . .P @@ -34,12 +40,17 @@ $ git commit \-m "Some changes" \.\.\. $ git checkout master $ git refactor finish mainlib_refactor + +$ $ git refactor \-r upstream mainlib_refactor . .fi . .SH "AUTHOR" Written by Jesús Espino <\fIjespinog@gmail\.com\fR> . +.br +Modified by Mark Pitman <\fImark\.pitman@gmail\.com\fR> +. .SH "REPORTING BUGS" <\fIhttps://github\.com/tj/git\-extras/issues\fR> . diff --git a/man/git-refactor.html b/man/git-refactor.html index 4a1e292..3f2e333 100644 --- a/man/git-refactor.html +++ b/man/git-refactor.html @@ -76,7 +76,7 @@

SYNOPSIS

-

git-refactor [finish] <name>

+

git-refactor [-r|--remote [remote_name]] [finish] <name>

DESCRIPTION

@@ -84,6 +84,10 @@

OPTIONS

+

<-r|--remote [remote_name]>

+ +

Setup a remote tracking branch using remote_name. If remote_name is not supplied, use origin by default.

+

<finish>

Merge and delete the refactor branch.

@@ -100,11 +104,14 @@ $ git commit -m "Some changes" ... $ git checkout master $ git refactor finish mainlib_refactor + +$ $ git refactor -r upstream mainlib_refactor

AUTHOR

-

Written by Jesús Espino <jespinog@gmail.com>

+

Written by Jesús Espino <jespinog@gmail.com>
+Modified by Mark Pitman <mark.pitman@gmail.com>

REPORTING BUGS

@@ -117,7 +124,7 @@ $ git refactor finish mainlib_refactor
  1. -
  2. December 2015
    3. +
  3. July 2017
  4. git-refactor(1)
diff --git a/man/git-refactor.md b/man/git-refactor.md index a394ea1..b1f9676 100644 --- a/man/git-refactor.md +++ b/man/git-refactor.md @@ -3,7 +3,7 @@ git-refactor(1) -- Create refactor branch ## SYNOPSIS -`git-refactor` [finish] <name> +`git-refactor` [-r|--remote [remote_name]] [finish] <name> ## DESCRIPTION @@ -11,6 +11,10 @@ git-refactor(1) -- Create refactor branch ## OPTIONS + <-r|--remote [remote_name]> + + Setup a remote tracking branch using `remote_name`. If `remote_name` is not supplied, use `origin` by default. + <finish> Merge and delete the refactor branch. @@ -28,9 +32,12 @@ git-refactor(1) -- Create refactor branch $ git checkout master $ git refactor finish mainlib_refactor + $ $ git refactor -r upstream mainlib_refactor + ## AUTHOR -Written by Jesús Espino <> +Written by Jesús Espino <> +Modified by Mark Pitman <> ## REPORTING BUGS