Permalink
Browse files

Update README.md with flag commands

  • Loading branch information...
1 parent ab7fda2 commit a14f427f6a14c08716c793cc9e6ea88ec3ecb2e0 @ijcd committed Apr 7, 2012
Showing with 256 additions and 148 deletions.
  1. +3 −0 .gitignore
  2. +235 −0 README.md
  3. +0 −148 README.mdown
  4. +18 −0 contrib/make-docflags.sh
View
@@ -2,3 +2,6 @@ debian/files
debian/*.substvars
debian/*.debhelper.log
debian/*/*
+\#*
+*~
+.#*
View
235 README.md
@@ -0,0 +1,235 @@
+git-flow
+========
+
+A collection of Git extensions to provide high-level repository operations
+for Vincent Driessen's [branching model](http://nvie.com/git-model "original
+blog post").
+
+
+Getting started
+---------------
+For the best introduction to get started with `git flow`, please read Jeff
+Kreeftmeijer's blog post:
+
+[http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/)
+
+Or have a look at one of these screen casts:
+
+* [How to use a scalable Git branching model called git-flow](http://buildamodule.com/video/change-management-and-version-control-deploying-releases-features-and-fixes-with-git-how-to-use-a-scalable-git-branching-model-called-gitflow) (by Build a Module)
+* [A short introduction to git-flow](http://vimeo.com/16018419) (by Mark Derricutt)
+* [On the path with git-flow](http://codesherpas.com/screencasts/on_the_path_gitflow.mov) (by Dave Bock)
+
+
+Installing git-flow
+-------------------
+See the Wiki for up-to-date [Installation Instructions](https://github.com/nvie/gitflow/wiki/Installation).
+
+
+Integration with your shell
+---------------------------
+For those who use the [Bash](http://www.gnu.org/software/bash/) or
+[ZSH](http://www.zsh.org) shell, please check out the excellent work on the
+[git-flow-completion](http://github.com/bobthecow/git-flow-completion) project
+by [bobthecow](http://github.com/bobthecow). It offers tab-completion for all
+git-flow subcommands and branch names.
+
+
+FAQ
+---
+See the [FAQ](http://github.com/nvie/gitflow/wiki/FAQ) section of the project
+Wiki.
+
+Overview
+--------
+
+### Initialization
+
+To initialize a new repo with the basic branch structure, use:
+
+ git flow init [-d]
+
+This will then interactively prompt you with some questions on which branches
+you would like to use as development and production branches, and how you
+would like your prefixes be named. You may simply press Return on any of
+those questions to accept the (sane) default suggestions.
+
+The ``-d`` flag will accept all defaults.
+
+
+### Creating feature/release/hotfix/support branches
+
+* To list/start/finish feature branches, use:
+
+ git flow feature
+ git flow feature start <name> [<base>]
+ git flow feature finish <name>
+
+ For feature branches, the `<base>` arg must be a commit on `develop`.
+
+* To push/pull a feature branch to the remote repository, use:
+
+ git flow feature publish <name>
+ git flow feature pull <remote> <name>
+
+* To list/start/finish release branches, use:
+
+ git flow release
+ git flow release start <release> [<base>]
+ git flow release finish <release>
+
+ For release branches, the `<base>` arg must be a commit on `develop`.
+
+* To list/start/finish hotfix branches, use:
+
+ git flow hotfix
+ git flow hotfix start <release> [<base>]
+ git flow hotfix finish <release>
+
+ For hotfix branches, the `<base>` arg must be a commit on `master`.
+
+* To list/start support branches, use:
+
+ git flow support
+ git flow support start <release> <base>
+
+ For support branches, the `<base>` arg must be a commit on `master`.
+
+Commands
+--------
+
+* Init:
+
+ git flow init [-fd]
+
+ Flags:
+ -d,--[no]defaults: use default branch naming conventions (default: false)
+ -f,--[no]force: force setting of gitflow branches, even if already configured (default: false)
+ -h,--[no]help: show this help (default: false)
+
+* Feature branches:
+
+ git flow feature [list] [-v]
+ git flow feature start [-F] <name> [<base>]
+ git flow feature finish [-rFkD] [<name|nameprefix>]
+ git flow feature publish <name>
+ git flow feature track <name>
+ git flow feature diff [<name|nameprefix>]
+ git flow feature rebase [-i] [<name|nameprefix>]
+ git flow feature checkout [<name|nameprefix>]
+ git flow feature pull [-r] <remote> [<name>]
+
+ Flags:
+ -D,--[no]force_delete: force delete feature branch after finish (default: false)
+ -F,--[no]fetch: fetch from origin before performing finish (default: false)
+ -F,--[no]fetch: fetch from origin before performing local operation (default: false)
+ -h,--[no]help: show this help (default: false)
+ -i,--[no]interactive: do an interactive rebase (default: false)
+ -k,--[no]keep: keep branch after performing finish (default: false)
+ -r,--[no]rebase: pull with rebase (default: false)
+ -r,--[no]rebase: rebase instead of merge (default: false)
+ -v,--[no]verbose: verbose (more) output (default: false)
+
+* Release branches:
+
+ git flow release [list] [-v]
+ git flow release start [-F] <version> [<base>]
+ git flow release finish [-Fsumpk] <version>
+ git flow release publish <name>
+ git flow release track <name>
+
+ Flags:
+ -F,--[no]fetch: fetch from origin before performing finish (default: false)
+ -h,--[no]help: show this help (default: false)
+ -k,--[no]keep: keep branch after performing finish (default: false)
+ -m,--message: use the given tag message (default: '')
+ -n,--[no]notag: don't tag this release (default: false)
+ -p,--[no]push: push to origin after performing finish (default: false)
+ -s,--[no]sign: sign the release tag cryptographically (default: false) (default: '')
+ -u,--signingkey: use the given GPG-key for the digital signature (implies -s)
+ -v,--[no]verbose: verbose (more) output (default: false)
+
+* Hotfix branches:
+
+ git flow hotfix [list] [-v]
+ git flow hotfix start [-F] <version> [<base>]
+ git flow hotfix finish [-Fsumpk] <version>
+ git flow hotfix publish <version>
+
+ Flags:
+ -F,--[no]fetch: fetch from origin before performing finish (default: false)
+ -h,--[no]help: show this help (default: false)
+ -k,--[no]keep: keep branch after performing finish (default: false)
+ -m,--message: use the given tag message (default: '')
+ -n,--[no]notag: don't tag this release (default: false)
+ -p,--[no]push: push to origin after performing finish (default: false)
+ -s,--[no]sign: sign the release tag cryptographically (default: false)
+ -u,--signingkey: use the given GPG-key for the digital signature (implies -s) (default: '')
+ -v,--[no]verbose: verbose (more) output (default: false)
+
+* Support branches:
+
+ git flow support [list] [-v]
+ git flow support start [-F] <version> <base>
+
+ Flags:
+ -F,--[no]fetch: fetch from origin before performing finish (default: false)
+ -h,--[no]help: show this help (default: false)
+ -v,--[no]verbose: verbose (more) output (default: false)
+
+* Version:
+
+ git flow version
+
+
+Please help out
+---------------
+This project is still under development. Feedback and suggestions are very
+welcome and I encourage you to use the [Issues
+list](http://github.com/nvie/gitflow/issues) on Github to provide that
+feedback.
+
+Feel free to fork this repo and to commit your additions. For a list of all
+contributors, please see the [AUTHORS](AUTHORS) file.
+
+Any questions, tips, or general discussion can be posted to our Google group:
+[http://groups.google.com/group/gitflow-users](http://groups.google.com/group/gitflow-users)
+
+Contributing
+------------
+Fork the repository. Then, run:
+
+ git clone --recursive git@github.com:<username>/gitflow.git
+ cd gitflow
+ git branch master origin/master
+ git flow init -d
+ git flow feature start <your feature>
+
+Then, do work and commit your changes. **Hint**: ``export PATH=`pwd`:$PATH``
+from within the gitflow directory makes sure you're using the version of
+gitflow you're currently developing.
+
+ git flow feature publish <your feature>
+
+When done, open a pull request to your feature branch.
+
+License terms
+-------------
+git-flow is published under the liberal terms of the BSD License, see the
+[LICENSE](LICENSE) file. Although the BSD License does not require you to share
+any modifications you make to the source code, you are very much encouraged and
+invited to contribute back your modifications to the community, preferably
+in a Github fork, of course.
+
+Showing your appreciation
+=========================
+A few people already requested it, so now it's here: a Flattr button.
+
+Of course, the best way to show your appreciation for the original
+[blog post](http://nvie.com/git-model) or the git-flow tool itself remains
+contributing to the community. If you'd like to show your appreciation in
+another way, however, consider Flattr'ing me:
+
+[![Flattr this][2]][1]
+
+[1]: http://flattr.com/thing/53771/git-flow
+[2]: http://api.flattr.com/button/button-static-50x60.png
View
@@ -1,148 +0,0 @@
-git-flow
-========
-
-A collection of Git extensions to provide high-level repository operations
-for Vincent Driessen's [branching model](http://nvie.com/git-model "original
-blog post").
-
-
-Getting started
----------------
-For the best introduction to get started with `git flow`, please read Jeff
-Kreeftmeijer's blog post:
-
-[http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/)
-
-Or have a look at one of these screen casts:
-
-* [How to use a scalable Git branching model called git-flow](http://buildamodule.com/video/change-management-and-version-control-deploying-releases-features-and-fixes-with-git-how-to-use-a-scalable-git-branching-model-called-gitflow) (by Build a Module)
-* [A short introduction to git-flow](http://vimeo.com/16018419) (by Mark Derricutt)
-* [On the path with git-flow](http://codesherpas.com/screencasts/on_the_path_gitflow.mov) (by Dave Bock)
-
-
-Installing git-flow
--------------------
-See the Wiki for up-to-date [Installation Instructions](https://github.com/nvie/gitflow/wiki/Installation).
-
-
-Integration with your shell
----------------------------
-For those who use the [Bash](http://www.gnu.org/software/bash/) or
-[ZSH](http://www.zsh.org) shell, please check out the excellent work on the
-[git-flow-completion](http://github.com/bobthecow/git-flow-completion) project
-by [bobthecow](http://github.com/bobthecow). It offers tab-completion for all
-git-flow subcommands and branch names.
-
-
-FAQ
----
-See the [FAQ](http://github.com/nvie/gitflow/wiki/FAQ) section of the project
-Wiki.
-
-
-Please help out
----------------
-This project is still under development. Feedback and suggestions are very
-welcome and I encourage you to use the [Issues
-list](http://github.com/nvie/gitflow/issues) on Github to provide that
-feedback.
-
-Feel free to fork this repo and to commit your additions. For a list of all
-contributors, please see the [AUTHORS](AUTHORS) file.
-
-Any questions, tips, or general discussion can be posted to our Google group:
-[http://groups.google.com/group/gitflow-users](http://groups.google.com/group/gitflow-users)
-
-Contributing
-------------
-Fork the repository. Then, run:
-
- git clone --recursive git@github.com:<username>/gitflow.git
- cd gitflow
- git branch master origin/master
- git flow init -d
- git flow feature start <your feature>
-
-Then, do work and commit your changes. **Hint**: ``export PATH=`pwd`:$PATH``
-from within the gitflow directory makes sure you're using the version of
-gitflow you're currently developing.
-
- git flow feature publish <your feature>
-
-When done, open a pull request to your feature branch.
-
-License terms
--------------
-git-flow is published under the liberal terms of the BSD License, see the
-[LICENSE](LICENSE) file. Although the BSD License does not require you to share
-any modifications you make to the source code, you are very much encouraged and
-invited to contribute back your modifications to the community, preferably
-in a Github fork, of course.
-
-
-### Initialization
-
-To initialize a new repo with the basic branch structure, use:
-
- git flow init [-d]
-
-This will then interactively prompt you with some questions on which branches
-you would like to use as development and production branches, and how you
-would like your prefixes be named. You may simply press Return on any of
-those questions to accept the (sane) default suggestions.
-
-The ``-d`` flag will accept all defaults.
-
-
-### Creating feature/release/hotfix/support branches
-
-* To list/start/finish feature branches, use:
-
- git flow feature
- git flow feature start <name> [<base>]
- git flow feature finish <name>
-
- For feature branches, the `<base>` arg must be a commit on `develop`.
-
-* To push/pull a feature branch to the remote repository, use:
-
- git flow feature publish <name>
- git flow feature pull <remote> <name>
-
-* To list/start/finish release branches, use:
-
- git flow release
- git flow release start <release> [<base>]
- git flow release finish <release>
-
- For release branches, the `<base>` arg must be a commit on `develop`.
-
-* To list/start/finish hotfix branches, use:
-
- git flow hotfix
- git flow hotfix start <release> [<base>]
- git flow hotfix finish <release>
-
- For hotfix branches, the `<base>` arg must be a commit on `master`.
-
-* To list/start support branches, use:
-
- git flow support
- git flow support start <release> <base>
-
- For support branches, the `<base>` arg must be a commit on `master`.
-
-
-Showing your appreciation
-=========================
-A few people already requested it, so now it's here: a Flattr button.
-
-Of course, the best way to show your appreciation for the original
-[blog post](http://nvie.com/git-model) or the git-flow tool itself remains
-contributing to the community. If you'd like to show your appreciation in
-another way, however, consider Flattr'ing me:
-
-[![Flattr this][2]][1]
-
-[1]: http://flattr.com/thing/53771/git-flow
-[2]: http://api.flattr.com/button/button-static-50x60.png
Oops, something went wrong.

0 comments on commit a14f427

Please sign in to comment.