Re: [PATCH] Document git-runstatus

From: Rene Scharfe <rene.scharfe@lsrfire.ath.cx>
Date: Nov 18, 2006, 15:04 UTC
Message-ID: <455F210B.8000107@lsrfire.ath.cx>
In-Reply-To: <20061118143511.GM7201@pasky.or.cz>

Petr Baudis schrieb:

Show 9 quoted lines

> On Sat, Nov 18, 2006 at 03:26:44PM CET, Sean wrote:
>> On Sat, 18 Nov 2006 15:15:49 +0100
>> Rene Scharfe <rene.scharfe@lsrfire.ath.cx> wrote:
>>
>>> I copied most of the text from git-status.txt.
>> [...]	
>>> +git-runstatus - Show working tree status
> 
> Don't forget to add it to the list of commands.

Good catch, thanks.  An incremental patch follows below.

>> How is git-runstatus different from "git status"?
> 
> I have the same question.

git-status is a wrapper around git-runstatus that takes the same options as git-commit. It could have been named 'git-commit --dry-run'.

>> Should this command be viewed simply as plumbing, and if so does it
>> deserve a man page or just textual documentation in the source?
> 
> All commands deserve a man page.

Exactly.  Even plumbers read manuals ;-).  Well, me at least.

René

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 52bc05a..63b1746 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -424,6 +424,9 @@ gitlink:git-pack-redundant[1]::
 gitlink:git-rev-list[1]::
 	Lists commit objects in reverse chronological order.
 
+gitlink:git-runstatus[1]::
+	Show working tree status.
+
 gitlink:git-show-index[1]::
 	Displays contents of a pack idx file.