git-up 0.5.9 → 0.5.10

data/README.md

@@ -1,5 +1,8 @@
-git-up
-======
+git-up(1) -- fetch and rebase all locally-tracked remote branches
+=================================================================
+
+SYNOPSIS
+--------
 
 `git pull` has two problems:
 
@@ -8,24 +11,24 @@ git-up
 
 Solve them once and for all.
 
-install
+INSTALL
 -------
 
     $ gem install git-up
 
 Windows support is predictably absent. Try the [Python port](https://github.com/msiemens/PyGitUp), which was started for that reason.
 
-use
+USE
 ---
 
 ![$ git up](http://dl.dropbox.com/u/166030/git-up/screenshot.png)
 
-although
+ALTHOUGH
 --------
 
 `git-up` might mess up your branches, or set your chest hair on fire, or be racist to your cat, I don't know. It works for me.
 
-difficulties
+DIFFICULTIES
 ------------
 
 ### Windows
@@ -35,7 +38,7 @@ Windows support is an ongoing pain. Have a look at [this ticket](https://github.
 
 If you're using RVM and you get this error, [read this](https://github.com/aanand/git-up/blob/master/RVM.md).
 
-configuration
+CONFIGURATION
 -------------
 
 `git-up` has a few configuration options, which use git's configuration system. Each can be set either globally or per-project. To set an option globally, append the `--global` flag to `git config`, which you can run anywhere:

data/lib/git-up.rb

@@ -39,14 +39,41 @@ Fetch and rebase all remotely-tracked branches.
     production     #{"up to date".green}
 
 There are no command-line options, but there are a few
-`git config` variables you can set, which are documented here:
-#{"https://github.com/aanand/git-up#configuration".cyan}
+`git config` variables you can set. For info on those
+and more, check out the man page:
+
+    $ git up man
+
+Or install it to your system, so you can get to it with
+`man git-up` or `git help up`:
+
+    $ git up install-man
 
 BANNER
 
+    man_path = File.expand_path('../../man/git-up.1', __FILE__)
+
     case argv
     when []
       return
+    when ["man"]
+      system "man", man_path
+      exit
+    when ["install-man"]
+      destination = "/usr/local/share/man"
+      print "Destination to install man page to [#{destination}]: "
+      override = $stdin.gets.strip
+      destination = override if override.length > 0
+
+      dest_dir  = File.join(destination, "man1")
+      dest_path = File.join(dest_dir, File.basename(man_path))
+
+      exit(1) unless system "mkdir", "-p", dest_dir
+      exit(1) unless system "cp", man_path, dest_path
+
+      puts "Installed to #{dest_path}"
+
+      exit
     when ["-h"], ["--help"]
       $stderr.puts(banner)
       exit

data/lib/git-up/version.rb

@@ -1,3 +1,3 @@
 class GitUp
-  VERSION = "0.5.9"
+  VERSION = "0.5.10"
 end

data/man/git-up.1

@@ -0,0 +1,99 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GIT\-UP" "1" "July 2013" "" ""
+.
+.SH "NAME"
+\fBgit\-up\fR \- fetch and rebase all locally\-tracked remote branches
+.
+.SH "SYNOPSIS"
+\fBgit pull\fR has two problems:
+.
+.IP "\(bu" 4
+It merges upstream changes by default, when it\'s really more polite to rebase over them \fIhttp://www\.gitready\.com/advanced/2009/02/11/pull\-with\-rebase\.html\fR, unless your collaborators enjoy a commit graph that looks like bedhead\.
+.
+.IP "\(bu" 4
+It only updates the branch you\'re currently on, which means \fBgit push\fR will shout at you for being behind on branches you don\'t particularly care about right now\.
+.
+.IP "" 0
+.
+.P
+Solve them once and for all\.
+.
+.SH "INSTALL"
+.
+.nf
+
+$ gem install git\-up
+.
+.fi
+.
+.P
+Windows support is predictably absent\. Try the Python port \fIhttps://github\.com/msiemens/PyGitUp\fR, which was started for that reason\.
+.
+.SH "USE"
+.
+.nf
+
+$ git up
+.
+.fi
+.
+.SH "ALTHOUGH"
+\fBgit\-up\fR might mess up your branches, or set your chest hair on fire, or be racist to your cat, I don\'t know\. It works for me\.
+.
+.SH "DIFFICULTIES"
+.
+.SS "Windows"
+Windows support is an ongoing pain\. Have a look at this ticket \fIhttps://github\.com/aanand/git\-up/issues/34\fR if you really need it, or if you\'re bored\.
+.
+.SS "spawn\.rb:187:in `_pspawn\': Invalid command name (ArgumentError)"
+If you\'re using RVM and you get this error, read this \fIhttps://github\.com/aanand/git\-up/blob/master/RVM\.md\fR\.
+.
+.SH "CONFIGURATION"
+\fBgit\-up\fR has a few configuration options, which use git\'s configuration system\. Each can be set either globally or per\-project\. To set an option globally, append the \fB\-\-global\fR flag to \fBgit config\fR, which you can run anywhere:
+.
+.IP "" 4
+.
+.nf
+
+git config \-\-global git\-up\.bundler\.check true
+.
+.fi
+.
+.IP "" 0
+.
+.P
+To set it within a project, run the command inside that project\'s directory and omit the \fB\-\-global\fR flag:
+.
+.IP "" 4
+.
+.nf
+
+cd myproject
+git config git\-up\.bundler\.check true
+.
+.fi
+.
+.IP "" 0
+.
+.SS "git\-up\.bundler\.check [true|false]"
+Default: \fBfalse\fR\. If \fBtrue\fR, git\-up will check your app for any new bundled gems and suggest a \fBbundle install\fR if necessary\.
+.
+.SS "git\-up\.bundler\.autoinstall [true|false]"
+Default: \fBfalse\fR\. If \fBtrue\fR, and if \fBgit\-up\.bundler\.check\fR is also set to \fBtrue\fR, git\-up will run \fBbundle install\fR for you if it finds missing gems\.
+.
+.SS "git\-up\.fetch\.prune [true|false]"
+Default: \fBtrue\fR\. Append the \fB\-\-prune\fR flag when running \fBgit fetch\fR, if your git version supports it (1\.6\.6 or greater), telling it to remove any remote tracking branches which no longer exist on the remote \fIhttp://linux\.die\.net/man/1/git\-fetch\fR\.
+.
+.SS "git\-up\.fetch\.all [true|false]"
+Default: \fBfalse\fR\. Normally, git\-up will only fetch remotes for which there is at least one local tracking branch\. Setting this option to \fBtrue\fR will make git\-up always fetch from all remotes, which is useful if e\.g\. you use a remote to push to your CI system but never check those branches out\.
+.
+.SS "git\-up\.rebase\.arguments [string]"
+Default: \fBunset\fR\. Additional arguments to pass to \fBgit rebase\fR\. For example, setting this to \fB\-\-preserve\-merges\fR will recreate your merge commits in the rebased branch\.
+.
+.SS "git\-up\.rebase\.auto [true|false]"
+Default: \fBtrue\fR\. If this option is set to \fBfalse\fR, git\-up will not rebase branches for you\. Instead, it will print a message saying they are diverged and let you handle rebasing them later\. This can be useful if you have a lot of in\-progress work that you don\'t want to deal with at once, but still want to update other branches\.
+.
+.SS "git\-up\.rebase\.log\-hook \"COMMAND\""
+Default: \fBunset\fR\. Runs \fBCOMMAND\fR every time a branch is rebased or fast\-forwarded, with the old head as \fB$1\fR and the new head as \fB$2\fR\. This can be used to view logs or diffs of incoming changes\. For example: \fB\'echo "changes on $1:"; git log \-\-oneline \-\-decorate $1\.\.$2\'\fR

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-up
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.5.10
   prerelease: 
 platform: ruby
 authors:
@@ -74,6 +74,7 @@ files:
 - bin/git-up
 - lib/git-up/version.rb
 - lib/git-up.rb
+- man/git-up.1
 - LICENSE
 - README.md
 homepage: http://github.com/aanand/git-up