threads / patch / 33157

patchgit.c: make usage match manual page

Subject: [PATCH] git.c: make usage match manual page

## tl;dr

4 messages between Mar 11, 2013 and Mar 11, 2013. Diffs are folded; open one to read it.

replies: 3people: 2as markdown or json

Kevin Bracey· Mar 11, 2013, 19:44 UTC · lore

Re-ordered option list in command-line usage to match the manual page. Also makes it less than 80-characters wide.

Signed-off-by: Kevin Bracey <kevin@bracey.fi>
---
 git.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Show changes to git.c +2 −2

diff --git a/git.c b/git.c
index d33f9b3..2a98624 100644
--- a/git.c
+++ b/git.c
@@ -6,10 +6,10 @@
 #include "run-command.h"
 
 const char git_usage_string[] =
-	"git [--version] [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
+	"git [--version] [--help] [-c name=value]\n"
+	"           [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
 	"           [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]\n"
 	"           [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
-	"           [-c name=value] [--help]\n"
 	"           <command> [<args>]";
 
 const char git_more_info_string[] =

-- 
1.8.2.rc3.7.g1100d09.dirty

Junio C Hamano· Mar 11, 2013, 19:58 UTC · re: Kevin Bracey · lore

Re: [PATCH] git.c: make usage match manual page

Kevin Bracey <kevin@bracey.fi> writes:

> Re-ordered option list in command-line usage to match the manual page.
> Also makes it less than 80-characters wide.

Thanks (s/Re-ordered/reorder/ and s/makes/make/, though).

Is git.c the only one whose "-h" output does not match the manual synopsis?

Show 23 quoted lines

>
> Signed-off-by: Kevin Bracey <kevin@bracey.fi>
> ---
>  git.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/git.c b/git.c
> index d33f9b3..2a98624 100644
> --- a/git.c
> +++ b/git.c
> @@ -6,10 +6,10 @@
>  #include "run-command.h"
>  
>  const char git_usage_string[] =
> -	"git [--version] [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
> +	"git [--version] [--help] [-c name=value]\n"
> +	"           [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
>  	"           [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]\n"
>  	"           [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
> -	"           [-c name=value] [--help]\n"
>  	"           <command> [<args>]";
>  
>  const char git_more_info_string[] =

Kevin Bracey· Mar 11, 2013, 20:43 UTC · re: Junio C Hamano · lore

Re: [PATCH] git.c: make usage match manual page

On 11/03/2013 21:58, Junio C Hamano wrote:

Show 5 quoted lines

> Kevin Bracey <kevin@bracey.fi> writes:
>
>> Re-ordered option list in command-line usage to match the manual page.
>> Also makes it less than 80-characters wide.
> Thanks (s/Re-ordered/reorder/ and s/makes/make/, though).

Got it. But I'm going to reword it, to follow the history of the manual change.

> Is git.c the only one whose "-h" output does not match the manual
> synopsis?
>

Generally, "-h" just puts "<options>" in the synopsis, and then prints a line per option, so most commands don't really match the manual "show all options on one line" style anyway. git.c is atypical. (Something else to look at for the whole git help thing? Should "git -h" print a option list in that style?)

But, yes, I've found a few others that are show almost the same thing as the manual but with subtle pointless differences. "git remote", for example. That's a larger project, I feel; the 80-column thing is key here.

Kevin

Kevin Bracey· Mar 11, 2013, 20:44 UTC · re: Kevin Bracey · lore

[PATCH] git.c: rearrange git synopsis to fit in 80 columns

Make the command line use the narrower synopsis layout that the man page has used since commit 68e4b55.

Signed-off-by: Kevin Bracey <kevin@bracey.fi>
---
 git.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Show changes to git.c +2 −2

diff --git a/git.c b/git.c
index d33f9b3..2a98624 100644
--- a/git.c
+++ b/git.c
@@ -6,10 +6,10 @@
 #include "run-command.h"
 
 const char git_usage_string[] =
-	"git [--version] [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
+	"git [--version] [--help] [-c name=value]\n"
+	"           [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
 	"           [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]\n"
 	"           [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
-	"           [-c name=value] [--help]\n"
 	"           <command> [<args>]";
 
 const char git_more_info_string[] =

-- 
1.8.2.rc3.7.g1100d09.dirty