summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2005-08-15 08:42:15 (GMT)
committerJunio C Hamano <junkio@cox.net>2005-08-15 10:00:22 (GMT)
commit7c27558c6236225b07c5d5def76299d2b5fe7635 (patch)
treea82cb780921131e30bdc1d646f7ca6bc1b667db6 /Documentation
parent365a00a3f280f8697e4735e1ac5b42a1c50f7887 (diff)
downloadgit-7c27558c6236225b07c5d5def76299d2b5fe7635.zip
git-7c27558c6236225b07c5d5def76299d2b5fe7635.tar.gz
git-7c27558c6236225b07c5d5def76299d2b5fe7635.tar.bz2
Add git-show-branches-script
Often I find myself wanting to do quick branches check when I am not in the windowing environment and cannot run gitk. This stupid script shows commits leading to the heads of interesting branches with indication which ones belong to which branches, so that fork point is somewhat discernible without using gitk. Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-show-branches-script.txt69
-rw-r--r--Documentation/git.txt2
2 files changed, 71 insertions, 0 deletions
diff --git a/Documentation/git-show-branches-script.txt b/Documentation/git-show-branches-script.txt
new file mode 100644
index 0000000..95c7013
--- /dev/null
+++ b/Documentation/git-show-branches-script.txt
@@ -0,0 +1,69 @@
+git-show-branches-script(1)
+===========================
+v0.99.4, Aug 2005
+
+NAME
+----
+git-show-branches-script - Show branches and their commits.
+
+SYNOPSIS
+--------
+'git show-branches <reference>...'
+
+DESCRIPTION
+-----------
+Shows the head commits from the named <reference> (or all refs under
+$GIT_DIR/refs/heads), and displays concise list of commit logs
+to show their relationship semi-visually.
+
+OPTIONS
+-------
+<reference>::
+ Name of the reference under $GIT_DIR/refs/heads/.
+
+
+OUTPUT
+------
+Given N <references>, the first N lines are the one-line
+description from their commit message. The branch head that is
+pointed at by $GIT_DIR/HEAD is prefixed with an asterisk '*'
+character while other heads are prefixed with a '!' character.
+
+Following these N lines, one-line log for each commit is
+displayed, indented N places. If a commit is on the I-th
+branch, the I-th indentation character shows a '+' sign;
+otherwise it shows a space.
+
+The following example shows three branches, "pu", "master" and
+"rc":
+
+ * [pu] Add cheap local clone '-s' flag to git-clone-script
+ ! [master] Documentation updates.
+ ! [rc] Merge master into rc
+ + Add cheap local clone '-s' flag to git-clone-script
+ + Alternate object pool mechanism updates.
+ + Audit rev-parse users.
+ ++ Documentation updates.
+ + Merge master into rc
+ +++ [PATCH] plug memory leak in diff.c::diff_free_filepair()
+
+These three branches all forked from a common commit, "[PATCH]
+plug memory leak...", and "rc" has one commit ahead of it. The
+"master" branch has one different commit that is also shared by
+"pu" branch, and "pu" branch has three more commits on top of
+"master" branch.
+
+
+Author
+------
+Written by Junio C Hamano <junkio@cox.net>
+
+
+Documentation
+--------------
+Documentation by Junio C Hamano.
+
+
+GIT
+---
+Part of the link:git.html[git] suite
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 5950332..8d7209b 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -188,6 +188,8 @@ link:git-pull-script.html[git-pull-script]::
link:git-commit-script.html[git-commit-script]::
Record changes to the repository.
+link:git-show-branches-script.html[git-show-branches-script]::
+ Show branches and their commits.
Ancilliary Commands
-------------------