Merge pull request #1 from bill-auger/master

Merge jwiegley#42

git-branch-status-subtree/.gitignore

@@ -0,0 +1,5 @@
+*
+!gbs-config.sh.inc.example
+!git-branch-status
+!LICENSE
+!README.md

git-branch-status-subtree/README.md

@@ -58,16 +58,16 @@ EXAMPLES:
     | feature-branch | (even)     | (ahead 2) | origin/feature-branch |
     | master         | (behind 1) | (even)    | origin/master         |
 
-  # compare two arbitrary branches (either local and either remote)
+  # compare two arbitrary branches - local or remote
   $ git-branch-status local-arbitrary-branch fork/arbitrary-branch
     | local-arbitrary-branch | (even)     | (ahead 1) | fork/arbitrary-branch  |
   $ git-branch-status fork/arbitrary-branch local-arbitrary-branch
     | fork/arbitrary-branch  | (behind 1) | (even)    | local-arbitrary-branch |
 
-  # show all branches - including those synchronized, non-tracking, or not checked-out
+  # show all branches - local and remote, regardless of state or relationship
   $ git-branch-status -a
   $ git-branch-status --all
-    | master         | (even)     | (ahead 1) | origin/master             |
+   *| master         | (even)     | (ahead 1) | origin/master             |
     | tracked-branch | (even)     | (even)    | origin/tracked-branch     |
     | (no local)     | n/a        | n/a       | origin/untracked-branch   |
     | local-branch   | n/a        | n/a       | (no upstream)             |
@@ -77,7 +77,7 @@ EXAMPLES:
   # show the current branch
   $ git-branch-status -b
   $ git-branch-status --branch
-    | current-branch | (even) | (ahead 2) | origin/current-branch |
+   *| current-branch | (even) | (ahead 2) | origin/current-branch |
 
   # show a specific branch
   $ git-branch-status          specific-branch
@@ -98,7 +98,7 @@ EXAMPLES:
   # show all local branches - including those synchronized or non-tracking
   $ git-branch-status -l
   $ git-branch-status --local
-    | master         | (even)     | (ahead 1) | origin/master         |
+   *| master         | (even)     | (ahead 1) | origin/master         |
     | tracked-branch | (even)     | (even)    | origin/tracked-branch |
     | local-branch   | n/a        | n/a       | (no upstream)         |
 
@@ -111,9 +111,9 @@ EXAMPLES:
   # show all branches with timestamps (like -a -d)
   $ git-branch-status -v
   $ git-branch-status --verbose
-    | 1999-12-31 local   | n/a        | n/a    | (no upstream)             |
-    | 1999-12-31 master  | (behind 1) | (even) | 2000-01-01 origin/master  |
-    | 1999-12-31 tracked | (even)     | (even) | 2000-01-01 origin/tracked |
+    | 1999-12-31 master    | (behind 1) | (even) | 2000-01-01 origin/master  |
+    | 1999-12-31 tracked   | (even)     | (even) | 2000-01-01 origin/tracked |
+   *| 1999-12-31 local-wip | n/a        | n/a    | (no upstream)             |
 ```
 
 

git-branch-status-subtree/gbs-config.sh.inc.example

@@ -0,0 +1,28 @@
+###############################################################################
+#  optional user-defined config for the 'git-branch-status' program           #
+#-----------------------------------------------------------------------------#
+#  * copy this file to: ./gbs-config.sh.inc (or $GBS_CFG_FILE) to customize   #
+#  * the text in this file must be valid BASH                                 #
+#  * you can also export these configuration options from the environment     #
+#      as well as an alternate location of this file (as $GBS_CFG_FILE)       #
+#  * environment variables will over-ride those defined in this file          #
+#  * environment variables should be named similarly to those in this file    #
+#      with the CFG_* prefix replaced with GBS_*                              #
+#      eg: export GBS_CFG_FILE=~/.config/git-branch-status/config.sh.inc      #
+#      eg: export GBS_FETCH_PERIOD=0                                          #
+###############################################################################
+
+
+# number of minutes between automatic `git fetch --all` calls
+#   0 => always, -1 => never (default: -1)
+readonly CFG_FETCH_PERIOD=-1
+
+
+# writable filesystem location for storage of the last-fetch timestamp
+#   (default: ~/.GBS_LAST_FETCH)
+readonly CFG_LAST_FETCH_FILE=~/.GBS_LAST_FETCH
+
+
+# whether or not to present ANSI colors
+#   0 => no, 1 => yes (default: 1)
+readonly CFG_USE_ANSI_COLOR=1