Browse Source

Document git-runstatus

I copied most of the text from git-status.txt.

Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx>
Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Rene Scharfe 18 years ago committed by Junio C Hamano
parent
commit
fd931411c0
  1. 69
      Documentation/git-runstatus.txt
  2. 3
      Documentation/git.txt
  3. 2
      builtin-runstatus.c

69
Documentation/git-runstatus.txt

@ -0,0 +1,69 @@ @@ -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

3
Documentation/git.txt

@ -302,6 +302,9 @@ gitlink:git-request-pull[1]:: @@ -302,6 +302,9 @@ gitlink:git-request-pull[1]::
gitlink:git-rev-parse[1]::
Pick out and massage parameters.

gitlink:git-runstatus[1]::
A helper for git-status and git-commit.

gitlink:git-send-email[1]::
Send patch e-mails out of "format-patch --mbox" output.


2
builtin-runstatus.c

@ -4,7 +4,7 @@ @@ -4,7 +4,7 @@
extern int wt_status_use_color;

static const char runstatus_usage[] =
"git-runstatus [--color|--nocolor] [--amend] [--verbose]";
"git-runstatus [--color|--nocolor] [--amend] [--verbose] [--untracked]";

int cmd_runstatus(int argc, const char **argv, const char *prefix)
{

Loading…
Cancel
Save