summaryrefslogtreecommitdiff
path: root/Documentation/git-runstatus.txt
diff options
context:
space:
mode:
authorShawn O. Pearce <spearce@spearce.org>2007-01-14 02:44:18 -0500
committerShawn O. Pearce <spearce@spearce.org>2007-01-14 02:44:18 -0500
commit1fcdd62adf81a172f45c7c6a58177212d500b9d9 (patch)
tree94acde078fd78c3d214fe09d45e85ed346a2f2d4 /Documentation/git-runstatus.txt
parent9938ffc53a15c755bbd3894c02492b940ea34c4c (diff)
parent696b1b507f8ff9e80a2edc4eced59ca8cdda920e (diff)
downloadgit-1fcdd62adf81a172f45c7c6a58177212d500b9d9.tar.gz
Merge branch 'master' into sp/fast-import
I'm bringing master in early so that the OBJ_OFS_DELTA implementation is available as part of the topic. This way git-fast-import can learn about this new slightly smaller and faster packfile format, and can generate them directly rather than needing to have them be repacked with git-pack-objects. Due to the API changes in master during the period of development of git-fast-import, a few minor tweaks to fast-import.c are needed to produce a working merge. I've done them here as part of the merge to ensure bisection always works. Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
Diffstat (limited to 'Documentation/git-runstatus.txt')
-rw-r--r--Documentation/git-runstatus.txt69
1 files changed, 69 insertions, 0 deletions
diff --git a/Documentation/git-runstatus.txt b/Documentation/git-runstatus.txt
new file mode 100644
index 0000000000..89d7b92731
--- /dev/null
+++ b/Documentation/git-runstatus.txt
@@ -0,0 +1,69 @@
+git-runstatus(1)
+================
+
+NAME
+----
+git-runstatus - A helper for git-status and git-commit
+
+
+SYNOPSIS
+--------
+'git-runstatus' [--color|--nocolor] [--amend] [--verbose] [--untracked]
+
+
+DESCRIPTION
+-----------
+Examines paths in the working tree that has changes unrecorded
+to the index file, and changes between the index file and the
+current HEAD commit. The former paths are what you _could_
+commit by running 'git-update-index' before running 'git
+commit', and the latter paths are what you _would_ commit by
+running 'git commit'.
+
+If there is no path that is different between the index file and
+the current HEAD commit, the command exits with non-zero status.
+
+Note that this is _not_ the user level command you would want to
+run from the command line. Use 'git-status' instead.
+
+
+OPTIONS
+-------
+--color::
+ Show colored status, highlighting modified file names.
+
+--nocolor::
+ Turn off coloring.
+
+--amend::
+ Show status based on HEAD^1, not HEAD, i.e. show what
+ 'git-commit --amend' would do.
+
+--verbose::
+ Show unified diff of all file changes.
+
+--untracked::
+ Show files in untracked directories, too. Without this
+ option only its name and a trailing slash are displayed
+ for each untracked directory.
+
+
+OUTPUT
+------
+The output from this command is designed to be used as a commit
+template comments, and all the output lines are prefixed with '#'.
+
+
+Author
+------
+Originally written by Linus Torvalds <torvalds@osdl.org> as part
+of git-commit, and later rewritten in C by Jeff King.
+
+Documentation
+--------------
+Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
+
+GIT
+---
+Part of the gitlink:git[7] suite
+