forked from mislav/hub
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Delete hub examples and configuration docs from the README
Man pages should be the canonical source of hub documentation. People should use `man help hub` instead of viewing the README, which might not even correspond to the version they have installed. This ends the confusing man page build system in which parts of the README are injected into `hub.1.ronn` source file, deletes the Rakefile and removes rake from gem bundle. The examples are deleted because they are now inlined with individual command documentation. So did the documentation for all hub commands get deleted from main man page in favor of individual man pages. However, this makes main man page have absolutely no listing of which commands are available. This will get addressed as we go forward.
- Loading branch information
Showing
6 changed files
with
38 additions
and
476 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,5 @@ gem 'cucumber', '~> 1.3.9' | |
| gem 'sinatra' | ||
|
|
||
| group :development do | ||
| gem 'rake', '~> 10.1.1' | ||
| gem 'ronn' | ||
| end | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -82,246 +82,6 @@ complement existing completion scripts that ship with git. | |
| * [hub bash completion](https://github.com/github/hub/blob/master/etc/hub.bash_completion.sh) | ||
| * [hub zsh completion](https://github.com/github/hub/blob/master/etc/hub.zsh_completion) | ||
|
|
||
| Commands | ||
| -------- | ||
|
|
||
| Assuming you've aliased hub as `git`, the following commands now have | ||
| superpowers: | ||
|
|
||
| ### git clone | ||
|
|
||
| $ git clone schacon/ticgit | ||
| > git clone git://github.com/schacon/ticgit.git | ||
|
|
||
| $ git clone -p schacon/ticgit | ||
| > git clone [email protected]:schacon/ticgit.git | ||
|
|
||
| $ git clone resque | ||
| > git clone [email protected]:YOUR_USER/resque.git | ||
|
|
||
| ### git remote add | ||
|
|
||
| $ git remote add rtomayko | ||
| > git remote add rtomayko git://github.com/rtomayko/CURRENT_REPO.git | ||
|
|
||
| $ git remote add -p rtomayko | ||
| > git remote add rtomayko [email protected]:rtomayko/CURRENT_REPO.git | ||
|
|
||
| $ git remote add origin | ||
| > git remote add origin git://github.com/YOUR_USER/CURRENT_REPO.git | ||
|
|
||
| ### git fetch | ||
|
|
||
| $ git fetch mislav | ||
| > git remote add mislav git://github.com/mislav/REPO.git | ||
| > git fetch mislav | ||
|
|
||
| $ git fetch mislav,xoebus | ||
| > git remote add mislav ... | ||
| > git remote add xoebus ... | ||
| > git fetch --multiple mislav xoebus | ||
|
|
||
| ### git cherry-pick | ||
|
|
||
| $ git cherry-pick http://github.com/mislav/REPO/commit/SHA | ||
| > git remote add -f --no-tags mislav git://github.com/mislav/REPO.git | ||
| > git cherry-pick SHA | ||
|
|
||
| $ git cherry-pick mislav@SHA | ||
| > git remote add -f --no-tags mislav git://github.com/mislav/CURRENT_REPO.git | ||
| > git cherry-pick SHA | ||
|
|
||
| $ git cherry-pick mislav@SHA | ||
| > git fetch mislav | ||
| > git cherry-pick SHA | ||
|
|
||
| ### git am, git apply | ||
|
|
||
| $ git am https://github.com/defunkt/hub/pull/55 | ||
| [ downloads patch via API ] | ||
| > git am /tmp/55.patch | ||
|
|
||
| $ git am --ignore-whitespace https://github.com/davidbalbert/hub/commit/fdb9921 | ||
| [ downloads patch via API ] | ||
| > git am --ignore-whitespace /tmp/fdb9921.patch | ||
|
|
||
| $ git apply https://gist.github.com/8da7fb575debd88c54cf | ||
| [ downloads patch via API ] | ||
| > git apply /tmp/gist-8da7fb575debd88c54cf.txt | ||
|
|
||
| ### git fork | ||
|
|
||
| $ git fork | ||
| [ repo forked on GitHub ] | ||
| > git remote add -f YOUR_USER [email protected]:YOUR_USER/CURRENT_REPO.git | ||
|
|
||
| ### git pull-request | ||
|
|
||
| # while on a topic branch called "feature": | ||
| $ git pull-request | ||
| [ opens text editor to edit title & body for the request ] | ||
| [ opened pull request on GitHub for "YOUR_USER:feature" ] | ||
|
|
||
| # explicit title, pull base & head: | ||
| $ git pull-request -m "Implemented feature X" -b defunkt:master -h mislav:feature | ||
|
|
||
| ### git checkout | ||
|
|
||
| $ git checkout https://github.com/defunkt/hub/pull/73 | ||
| > git remote add -f --no-tags -t feature mislav git://github.com/mislav/hub.git | ||
| > git checkout --track -B mislav-feature mislav/feature | ||
|
|
||
| $ git checkout https://github.com/defunkt/hub/pull/73 custom-branch-name | ||
|
|
||
| ### git merge | ||
|
|
||
| $ git merge https://github.com/defunkt/hub/pull/73 | ||
| > git fetch git://github.com/mislav/hub.git +refs/heads/feature:refs/remotes/mislav/feature | ||
| > git merge mislav/feature --no-ff -m 'Merge pull request #73 from mislav/feature...' | ||
|
|
||
| ### git create | ||
|
|
||
| $ git create | ||
| [ repo created on GitHub ] | ||
| > git remote add origin [email protected]:YOUR_USER/CURRENT_REPO.git | ||
|
|
||
| # with description: | ||
| $ git create -d 'It shall be mine, all mine!' | ||
|
|
||
| $ git create recipes | ||
| [ repo created on GitHub ] | ||
| > git remote add origin [email protected]:YOUR_USER/recipes.git | ||
|
|
||
| $ git create sinatra/recipes | ||
| [ repo created in GitHub organization ] | ||
| > git remote add origin [email protected]:sinatra/recipes.git | ||
|
|
||
| ### git init | ||
|
|
||
| $ git init -g | ||
| > git init | ||
| > git remote add origin [email protected]:YOUR_USER/REPO.git | ||
|
|
||
| ### git push | ||
|
|
||
| $ git push origin,staging,qa bert_timeout | ||
| > git push origin bert_timeout | ||
| > git push staging bert_timeout | ||
| > git push qa bert_timeout | ||
|
|
||
| ### git browse | ||
|
|
||
| $ git browse | ||
| > open https://github.com/YOUR_USER/CURRENT_REPO | ||
|
|
||
| $ git browse -- commit/SHA | ||
| > open https://github.com/YOUR_USER/CURRENT_REPO/commit/SHA | ||
|
|
||
| $ git browse -- issues | ||
| > open https://github.com/YOUR_USER/CURRENT_REPO/issues | ||
|
|
||
| $ git browse -- issues/10 | ||
| > open https://github.com/YOUR_USER/CURRENT_REPO/issues/10 | ||
|
|
||
| $ git browse schacon/ticgit | ||
| > open https://github.com/schacon/ticgit | ||
|
|
||
| $ git browse schacon/ticgit commit/SHA | ||
| > open https://github.com/schacon/ticgit/commit/SHA | ||
|
|
||
| $ git browse resque | ||
| > open https://github.com/YOUR_USER/resque | ||
|
|
||
| $ git browse resque network | ||
| > open https://github.com/YOUR_USER/resque/network | ||
|
|
||
| ### git compare | ||
|
|
||
| $ git compare refactor | ||
| > open https://github.com/CURRENT_REPO/compare/refactor | ||
|
|
||
| $ git compare 1.0..1.1 | ||
| > open https://github.com/CURRENT_REPO/compare/1.0...1.1 | ||
|
|
||
| $ git compare -u fix | ||
| > (https://github.com/CURRENT_REPO/compare/fix) | ||
|
|
||
| $ git compare other-user patch | ||
| > open https://github.com/other-user/REPO/compare/patch | ||
|
|
||
| ### git submodule | ||
|
|
||
| $ git submodule add wycats/bundler vendor/bundler | ||
| > git submodule add git://github.com/wycats/bundler.git vendor/bundler | ||
|
|
||
| $ git submodule add -p wycats/bundler vendor/bundler | ||
| > git submodule add [email protected]:wycats/bundler.git vendor/bundler | ||
|
|
||
| $ git submodule add -b ryppl --name pip ryppl/pip vendor/pip | ||
| > git submodule add -b ryppl --name pip git://github.com/ryppl/pip.git vendor/pip | ||
|
|
||
| ### git ci-status | ||
|
|
||
| $ git ci-status [commit] | ||
| > (prints CI state of commit and exits with appropriate code) | ||
| > One of: success (0), error (1), failure (1), pending (2), no status (3) | ||
|
|
||
|
|
||
| ### git help | ||
|
|
||
| $ git help | ||
| > (improved git help) | ||
| $ git help hub | ||
| > (hub man page) | ||
|
|
||
|
|
||
| Configuration | ||
| ------------- | ||
|
|
||
| ### GitHub OAuth authentication | ||
|
|
||
| Hub will prompt for GitHub username & password the first time it needs to access | ||
| the API and exchange it for an OAuth token, which it saves in "~/.config/hub". | ||
|
|
||
| To avoid being prompted, use **GITHUB_USER** and **GITHUB_PASSWORD** environment | ||
| variables. | ||
|
|
||
| Alternatively, you may provide **GITHUB_TOKEN**, an access token with | ||
| **repo** permissions. This will not be written to `~/.config/hub`. | ||
|
|
||
| ### HTTPS instead of git protocol | ||
|
|
||
| If you prefer the HTTPS protocol for GitHub repositories, you can set | ||
| "hub.protocol" to "https". This will affect `clone`, `fork`, `remote add` | ||
| and other operations that expand references to GitHub repositories as full | ||
| URLs that otherwise use git and ssh protocols. | ||
|
|
||
| "hub.protocol" only applies when the "OWNER/REPO" shorthand is used instead of | ||
| a full git URL. | ||
|
|
||
| # default behavior | ||
| $ git clone defunkt/repl | ||
| < git clone > | ||
|
|
||
| # opt into HTTPS: | ||
| $ git config --global hub.protocol https | ||
| $ git clone defunkt/repl | ||
| < https clone > | ||
|
|
||
| ### GitHub Enterprise | ||
|
|
||
| By default, hub will only work with repositories that have remotes which | ||
| point to github.com. GitHub Enterprise hosts need to be whitelisted to | ||
| configure hub to treat such remotes same as github.com: | ||
|
|
||
| $ git config --global --add hub.host my.git.org | ||
|
|
||
| The default host for commands like `init` and `clone` is still | ||
| github.com, but this can be affected with the `GITHUB_HOST` environment | ||
| variable: | ||
|
|
||
| $ GITHUB_HOST=my.git.org git clone myproject | ||
|
|
||
| Meta | ||
| ---- | ||
|
|
||
|
|
||
Oops, something went wrong.