From f6f45990ab6718da256fc0d5644bdecb70a0b4ba Mon Sep 17 00:00:00 2001 From: spacewander Date: Tue, 8 Sep 2015 13:37:30 +0800 Subject: [PATCH] update git-feature docs --- Commands.md | 2 +- man/git-feature.1 | 24 ++++++-- man/git-feature.1.html | 136 +++++++++++++++++++++++++++++++++++++++++ man/git-feature.md | 20 ++++-- 4 files changed, 170 insertions(+), 12 deletions(-) create mode 100644 man/git-feature.1.html diff --git a/Commands.md b/Commands.md index bda485a..13bd7fa 100644 --- a/Commands.md +++ b/Commands.md @@ -72,7 +72,7 @@ Sets up the `gh-pages` branch. (See [GitHub Pages](http://pages.github.com/) do ## git feature|refactor|bug|chore -Create the given feature, refactor, bug or chore branch `name`: +Create/Merge the given feature, refactor, bug or chore branch `name`: ```bash $ git feature dependencies diff --git a/man/git-feature.1 b/man/git-feature.1 index 2afa90c..5a21b9d 100644 --- a/man/git-feature.1 +++ b/man/git-feature.1 @@ -1,18 +1,24 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-FEATURE" "1" "April 2015" "" "" +.TH "GIT\-FEATURE" "1" "September 2015" "" "" . .SH "NAME" -\fBgit\-feature\fR \- Create feature branch +\fBgit\-feature\fR \- Create/Merge feature branch . .SH "SYNOPSIS" -\fBgit\-feature\fR [finish] +\fBgit\-feature\fR [\-a|\-\-alias branch_prefix] [finish] . .SH "DESCRIPTION" -Create the given feature branch +Create/Merge the given feature branch . .SH "OPTIONS" +<\-a|\-\-alias branch_prefix> +. +.P +use \fBbranch_prefix\fR instead of \fBfeature\fR +. +.P . .P @@ -30,10 +36,16 @@ The name of the feature branch\. $ git feature dependencies \.\.\. -$ git commit \-m "Some changes" +$ (feature/dependencies) git commit \-m "Some changes" \.\.\. -$ git checkout master +$ (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 dependencies . .fi . diff --git a/man/git-feature.1.html b/man/git-feature.1.html new file mode 100644 index 0000000..253d12c --- /dev/null +++ b/man/git-feature.1.html @@ -0,0 +1,136 @@ + + + + + + git-feature(1) - Create/Merge feature branch + + + + +
+ + + +
    +
  1. git-feature(1)
    2. +
  2. +
  3. git-feature(1)
    4. +
+ +

NAME

+

+ git-feature - Create/Merge feature branch +

+ +

SYNOPSIS

+ +

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

+ +

DESCRIPTION

+ +

Create/Merge the given feature branch

+ +

OPTIONS

+ +

<-a|--alias branch_prefix>

+ +

use branch_prefix instead of feature

+ +

<finish>

+ +

Merge and delete the feature branch.

+ +

<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
+
+$ 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 <jespinog@gmail.com>

+ +

REPORTING BUGS

+ +

<https://github.com/tj/git-extras/issues>

+ +

SEE ALSO

+ +

<https://github.com/tj/git-extras>

+ + +
    +
  1. +
  2. September 2015
    3. +
  3. git-feature(1)
    4. +
+ +
+ + diff --git a/man/git-feature.md b/man/git-feature.md index d9e7a6e..0c78c9c 100644 --- a/man/git-feature.md +++ b/man/git-feature.md @@ -1,16 +1,20 @@ -git-feature(1) -- Create feature branch +git-feature(1) -- Create/Merge feature branch ======================================= ## SYNOPSIS -`git-feature` [finish] <name> +`git-feature` [-a|--alias branch_prefix] [finish] <name> ## DESCRIPTION - Create the given feature branch + Create/Merge the given feature branch ## OPTIONS + <-a|--alias branch_prefix> + + use `branch_prefix` instead of `feature` + <finish> Merge and delete the feature branch. @@ -23,11 +27,17 @@ git-feature(1) -- Create feature branch $ git feature dependencies ... - $ git commit -m "Some changes" + $ (feature/dependencies) git commit -m "Some changes" ... - $ git checkout master + $ (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 dependencies + ## AUTHOR Written by Jesús Espino <>