threads / patch / 21012

patchRemove '< >' from [<options>] since it's not necessary.

Subject: [PATCH] Remove '< >' from [<options>] since it's not necessary.

## tl;dr

4 messages between Sep 20, 2009 and Sep 21, 2009. Diffs are folded; open one to read it.

replies: 3people: 3as markdown or json

Thiago Farina· Sep 20, 2009, 19:48 UTC · lore

Signed-off-by: Thiago Farina <tfransosi@gmail.com>
---
 builtin-log.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

Show changes to builtin-log.c +1 −1

diff --git a/builtin-log.c b/builtin-log.c
index 25e21ed..1685546 100644
--- a/builtin-log.c
+++ b/builtin-log.c
@@ -28,7 +28,7 @@ static const char *fmt_patch_subject_prefix = "PATCH";
 static const char *fmt_pretty;
 
 static const char * const builtin_log_usage =
-	"git log [<options>] [<since>..<until>] [[--] <path>...]\n"
+	"git log [options] [<since>..<until>] [[--] <path>...]\n"
 	"   or: git show [options] <object>...";
 
 static void cmd_log_init(int argc, const char **argv, const char *prefix,

-- 
1.6.5.rc1.37.gf5c31.dirty

tom fogal· Sep 20, 2009, 20:52 UTC · re: Thiago Farina · lore

Re: [PATCH] Remove '< >' from [<options>] since it's not necessary.

Thiago Farina <tfransosi@gmail.com> writes:

> -	"git log [<options>] [<since>..<until>] [[--] <path>...]\n"
> +	"git log [options] [<since>..<until>] [[--] <path>...]\n"
>  	"   or: git show [options] <object>...";

To me, "<blah>" implies to me that the other meant, "something which is sort-of `blah'-ish but is not actually the string literal, `blah'", whereas `blah' means, "the string literal, `blah'."

-tom

tom fogal· Sep 20, 2009, 21:12 UTC · re: tom fogal · lore

Re: [PATCH] Remove '< >' from [<options>] since it's not necessary.

tom fogal <tfogal@alumni.unh.edu> writes:

Show 6 quoted lines

> Thiago Farina <tfransosi@gmail.com> writes:
> > -	"git log [<options>] [<since>..<until>] [[--] <path>...]\n"
> > +	"git log [options] [<since>..<until>] [[--] <path>...]\n"
> >  	"   or: git show [options] <object>...";
> 
> To me, "<blah>" implies to me that the other meant, "something which

                                         ^^^^^
... author.  sorry.

-tom

Matthieu Moy· Sep 21, 2009, 06:50 UTC · re: tom fogal · lore

Re: [PATCH] Remove '< >' from [<options>] since it's not necessary.

tom fogal <tfogal@alumni.unh.edu> writes:

Show 8 quoted lines

> Thiago Farina <tfransosi@gmail.com> writes:
>> -	"git log [<options>] [<since>..<until>] [[--] <path>...]\n"
>> +	"git log [options] [<since>..<until>] [[--] <path>...]\n"
>>  	"   or: git show [options] <object>...";
>
> To me, "<blah>" implies to me that the author meant, "something which
> is sort-of `blah'-ish but is not actually the string literal, `blah'",
> whereas `blah' means, "the string literal, `blah'."

Strictly speaking, you're right, but in the particular case of [options], it's rather well established that it means "one or several options", and not the litteral "option". In any case, we should be consistant:

Documentation$ grep -n '\[<options>\]' *.txt git-log.txt:11:'git log' [<options>] [<since>..<until>] [[\--] <path>...] git-stash.txt:11:'git stash' list [<options>] git-stash.txt:67:list [<options>]:: Documentation$ grep -n '\[options\]' *.txt git-annotate.txt:10:'git annotate' [options] file [revision] gitcli.txt:84:usage: git-describe [options] <committish>* git-cvsserver.txt:25:'git cvsserver' [options] [pserver|server] [<directory> ...] git-fast-export.txt:11:'git fast-export [options]' | 'git fast-import' git-fast-import.txt:11:frontend | 'git fast-import' [options] git-rebase.txt:11:'git rebase' [-i | --interactive] [options] [--onto <newbase>] git-rebase.txt:13:'git rebase' [-i | --interactive] [options] --onto <newbase> git-rev-parse.txt:405:some-command [options] <args>... git-send-email.txt:11:'git send-email' [options] <file|directory|rev-list options>... git-show.txt:11:'git show' [options] <object>... git-svn.txt:10:'git svn' <command> [options] [arguments]

=> either get rid of the 3 occurences of [<options>], not just one, or get rid of all the [options]. My vote goes for the first.

-- Matthieu Moy http://www-verimag.imag.fr/~moy/