threads / patch / 21029

patchDocumentation: Update the style of 'git-describe' command.

Subject: [PATCH] Documentation: Update the style of 'git-describe' command.

## tl;dr

3 messages between Sep 22, 2009 and Sep 23, 2009. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Thiago Farina· Sep 22, 2009, 23:48 UTC · lore

Update the old version 'git-describe' that appears in the documentation. Since the new version is prefered, use 'git describe' instead.

Also changes 'committish' to 'commit-ish', since the latter form is the most used.

Signed-off-by: Thiago Farina <tfransosi@gmail.com>
---
 Documentation/gitcli.txt |    2 +-
 builtin-describe.c       |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Show changes to 2 files +2 −2

Documentation/gitcli.txt, builtin-describe.c

diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index be39ed7..b6c0637 100644
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -81,7 +81,7 @@ couple of magic command line options:
 +
 ---------------------------------------------
 $ git describe -h
-usage: git-describe [options] <committish>*
+usage: git describe [options] <commit-ish>*
 
     --contains            find the tag that comes after the commit
     --debug               debug search strategy on stderr
diff --git a/builtin-describe.c b/builtin-describe.c
index df67a73..961deb4 100644
--- a/builtin-describe.c
+++ b/builtin-describe.c
@@ -10,7 +10,7 @@
 #define MAX_TAGS	(FLAG_BITS - 1)
 
 static const char * const describe_usage[] = {
-	"git describe [options] <committish>*",
+	"git describe [options] <commit-ish>*",
 	NULL
 };

-- 
1.6.5.rc1.44.ga1675

Junio C Hamano· Sep 23, 2009, 00:07 UTC · re: Thiago Farina · lore

Re: [PATCH] Documentation: Update the style of 'git-describe' command.

Thiago Farina <tfransosi@gmail.com> writes:

>  $ git describe -h
> -usage: git-describe [options] <committish>*
> +usage: git describe [options] <commit-ish>*

I think the first half of this line is correct but the other half is not.

$ git grep --color -c -e committish -- Documentation/ Documentation/git-describe.txt:6 Documentation/git-fast-import.txt:8 Documentation/git-name-rev.txt:1 Documentation/git-shortlog.txt:1 Documentation/gitcli.txt:1 Documentation/howto/revert-branch-rebase.txt:1

$ git grep --color -c -e commit-ish -- Documentation/ Documentation/git-rebase.txt:1 Documentation/git.txt:2

Thiago Farina· Sep 23, 2009, 01:24 UTC · re: Junio C Hamano · lore

Re: [PATCH] Documentation: Update the style of 'git-describe' command.

On Tue, Sep 22, 2009 at 8:07 PM, Junio C Hamano <gitster@pobox.com> wrote:

Show 19 quoted lines

> Thiago Farina <tfransosi@gmail.com> writes:
>
>>  $ git describe -h
>> -usage: git-describe [options] <committish>*
>> +usage: git describe [options] <commit-ish>*
>
> I think the first half of this line is correct but the other half is not.
>
> $ git grep --color -c -e committish -- Documentation/
> Documentation/git-describe.txt:6
> Documentation/git-fast-import.txt:8
> Documentation/git-name-rev.txt:1
> Documentation/git-shortlog.txt:1
> Documentation/gitcli.txt:1
> Documentation/howto/revert-branch-rebase.txt:1
>
> $ git grep --color -c -e commit-ish -- Documentation/
> Documentation/git-rebase.txt:1
> Documentation/git.txt:2

I did this: git$ grep --color -n "commit-ish" *.c builtin-revert.c:29: "git revert [options] <commit-ish>", builtin-revert.c:34: "git cherry-pick [options] <commit-ish>", builtin-send-pack.c:368: * (3) if both new and old are commit-ish, and new is a remote.c:1388: /* Both new and old must be commit-ish and new is descendant of

git$ grep --color -n "committish" *.c builtin-describe.c:13: "git describe [options] <committish>*", builtin-merge.c:885: * committish that is the same as HEAD there instead.