From 45eed8f166d18bb5910e7721ba2d3d1f5957e350 Mon Sep 17 00:00:00 2001 From: Carlos Prado Date: Sun, 5 Apr 2020 02:43:25 +0200 Subject: [PATCH] updated git-feature documentation --- man/git-feature.1 | 79 +++++++++++++++++++++++++++++++++----------- man/git-feature.html | 53 ++++++++++++++++++----------- man/git-feature.md | 54 ++++++++++++++++++++---------- 3 files changed, 130 insertions(+), 56 deletions(-) diff --git a/man/git-feature.1 b/man/git-feature.1 index d637a35..d3a65d2 100644 --- a/man/git-feature.1 +++ b/man/git-feature.1 @@ -7,7 +7,10 @@ \fBgit\-feature\fR \- Create/Merge feature branch . .SH "SYNOPSIS" -\fBgit\-feature\fR [\-a|\-\-alias branch_prefix] [\-r|\-\-remote [remote_name]] [finish] +\fBgit\-feature\fR [\-a|\-\-alias branch_prefix] [\-r|\-\-remote [remote_name]] +. +.br +\fBgit\-feature\fR [\-a|\-\-alias branch_prefix] finish [\-\-squash] . .SH "DESCRIPTION" Create/Merge the given feature branch @@ -25,18 +28,18 @@ use \fBbranch_prefix\fR instead of \fBfeature\fR Setup a remote tracking branch using \fBremote_name\fR\. If \fBremote_name\fR is not supplied, use \fBorigin\fR by default\. . .P -<\-\-squash> -. -.P -Run a squash merge\. -. -.P . .P Merge and delete the feature branch\. . .P +<\-\-squash> +. +.P +Run a squash merge\. +. +.P . .P @@ -44,24 +47,59 @@ The name of the feature branch\. . .SH "EXAMPLES" . -.nf - +.TP +Start a new feature: +. +.IP $ git feature dependencies -\.\.\. +. +.br +\&\.\.\. +. +.br $ (feature/dependencies) git commit \-m "Some changes" -\.\.\. +. +.TP +Finish a feature with \-\-no\-ff merge: +. +.IP $ (feature/dependencies) git checkout master +. +.br $ git feature finish dependencies - -$ git alias features "feature \-a features" -$ git features dependencies -$ (features/dependencies) \.\.\. -$ (features/dependencies) git checkout master -$ git features finish \-\-squash dependencies - +. +.TP +Finish a feature with \-\-squash merge: +. +.IP +$ (feature/dependencies) git checkout master +. +.br +$ git feature finish \-\-squash dependencies +. +.TP +Publish a feature upstream: +. +.IP $ git feature dependencies \-r upstream . -.fi +.TP +Use custom branch prefix: +. +.IP +$ git alias features "feature \-a features" +. +.br +$ git features dependencies +. +.br +$ (features/dependencies) \.\.\. +. +.br +$ (features/dependencies) git checkout master +. +.br +$ git features finish dependencies . .SH "AUTHOR" Written by Jesús Espino <\fIjespinog@gmail\.com\fR> @@ -69,6 +107,9 @@ Written by Jesús Espino <\fIjespinog@gmail\.com\fR> .br Modified by Mark Pitman <\fImark\.pitman@gmail\.com\fR> . +.br +Modified by Carlos Prado <\fIcarlos\.prado@cpradog\.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 85d6113..b480aa6 100644 --- a/man/git-feature.html +++ b/man/git-feature.html @@ -76,7 +76,8 @@

SYNOPSIS

-

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

+

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

DESCRIPTION

@@ -92,40 +93,52 @@

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

-

<--squash>

- -

Run a squash merge.

-

<finish>

Merge and delete the feature branch.

+

<--squash>

+ +

Run a squash merge.

+

<name>

The name of the feature branch.

EXAMPLES

-
$ git feature dependencies
-...
-$ (feature/dependencies) git commit -m "Some changes"
-...
-$ (feature/dependencies) git checkout master
-$ git feature finish dependencies
+

+
Start a new feature:

 
-$ git alias features "feature -a features"
-$ git features dependencies
-$ (features/dependencies) ...
-$ (features/dependencies) git checkout master
-$ git features finish --squash dependencies
+
$ git feature dependencies

+...

+$ (feature/dependencies) git commit -m "Some changes"

+
Finish a feature with --no-ff merge:

+
+
$ (feature/dependencies) git checkout master

+$ git feature finish dependencies

+
Finish a feature with --squash merge:

+
+
$ (feature/dependencies) git checkout master

+$ git feature finish --squash dependencies

+
Publish a feature upstream:

+
+
$ git feature dependencies -r upstream

+
Use custom branch prefix:

+
+
$ git alias features "feature -a features"

+$ 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>
-Modified by Mark Pitman <mark.pitman@gmail.com>

+

Written by Jesús Espino <jespinog@gmail.com>
+Modified by Mark Pitman <mark.pitman@gmail.com>
+Modified by Carlos Prado <carlos.prado@cpradog.com>

REPORTING BUGS

diff --git a/man/git-feature.md b/man/git-feature.md index 5f36658..59dcb63 100644 --- a/man/git-feature.md +++ b/man/git-feature.md @@ -3,7 +3,8 @@ git-feature(1) -- Create/Merge feature branch ## SYNOPSIS -`git-feature` [-a|--alias branch_prefix] [-r|--remote [remote_name]] [finish] <name> +`git-feature` [-a|--alias branch_prefix] [-r|--remote [remote_name]] <name> +`git-feature` [-a|--alias branch_prefix] finish [--squash] <name> ## DESCRIPTION @@ -19,39 +20,58 @@ git-feature(1) -- Create/Merge feature branch Setup a remote tracking branch using `remote_name`. If `remote_name` is not supplied, use `origin` by default. - <--squash> - - Run a squash merge. - <finish> Merge and delete the feature branch. + <--squash> + + Run a squash merge. + <name> The name of the feature branch. ## EXAMPLES - $ git feature dependencies - ... - $ (feature/dependencies) git commit -m "Some changes" - ... - $ (feature/dependencies) git checkout master + * Start a new feature: + + + $ git feature dependencies + ... + $ (feature/dependencies) git commit -m "Some changes" + + * Finish a feature with --no-ff merge: + + + $ (feature/dependencies) git checkout master $ git feature finish dependencies - $ git alias features "feature -a features" - $ git features dependencies - $ (features/dependencies) ... - $ (features/dependencies) git checkout master - $ git features finish --squash dependencies + * Finish a feature with --squash merge: - $ git feature dependencies -r upstream + + $ (feature/dependencies) git checkout master + $ git feature finish --squash dependencies + + * Publish a feature upstream: + + + $ git feature dependencies -r upstream + + * Use custom branch prefix: + + + $ git alias features "feature -a features" + $ git features dependencies + $ (features/dependencies) ... + $ (features/dependencies) git checkout master + $ git features finish dependencies ## AUTHOR Written by Jesús Espino <> -Modified by Mark Pitman <> +Modified by Mark Pitman <> +Modified by Carlos Prado <> ## REPORTING BUGS