From: Rene Scharfe <rene.scharfe@lsrfire.ath.cx>
To: Junio C Hamano <junkio@cox.net>
Cc: Git Mailing List <git@vger.kernel.org>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Jeff King <peff@peff.net>
Subject: [PATCH] Document git-runstatus
Date: Sat, 18 Nov 2006 15:15:49 +0100 [thread overview]
Message-ID: <455F1595.9020009@lsrfire.ath.cx> (raw)
I copied most of the text from git-status.txt.
Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx>
---
Documentation/git-runstatus.txt | 66 +++++++++++++++++++++++++++++++++++++++
builtin-runstatus.c | 2 +-
2 files changed, 67 insertions(+), 1 deletions(-)
diff --git a/Documentation/git-runstatus.txt b/Documentation/git-runstatus.txt
new file mode 100644
index 0000000..c144c7b
--- /dev/null
+++ b/Documentation/git-runstatus.txt
@@ -0,0 +1,66 @@
+git-runstatus(1)
+================
+
+NAME
+----
+git-runstatus - Show working tree status
+
+
+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.
+
+
+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
+------
+Written 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
+
diff --git a/builtin-runstatus.c b/builtin-runstatus.c
index 303c556..0b63037 100644
--- a/builtin-runstatus.c
+++ b/builtin-runstatus.c
@@ -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)
{
--
1.4.4
next reply other threads:[~2006-11-18 14:15 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2006-11-18 14:15 Rene Scharfe [this message]
2006-11-18 14:26 ` [PATCH] Document git-runstatus Sean
[not found] ` <20061118092644.a9f15669.seanlkml@sympatico.ca>
2006-11-18 14:35 ` Petr Baudis
2006-11-18 15:04 ` Rene Scharfe
2006-11-18 16:04 ` Sean
2006-11-18 18:20 ` A Large Angry SCM
2006-11-18 18:49 ` Sean
[not found] ` <455F60EA.2080009@gmail.com>
2006-11-18 20:04 ` Sean
[not found] ` <20061118150431.81076072.seanlkml@sympatico.ca>
2006-11-19 18:13 ` Petr Baudis
2006-11-20 7:15 ` Joshua N Pritikin
2006-11-20 8:11 ` Jakub Narebski
2006-11-18 18:49 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=455F1595.9020009@lsrfire.ath.cx \
--to=rene.scharfe@lsrfire.ath.cx \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=junkio@cox.net \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox