git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] doc: improve usage string in MyFirstContribution

From
Emily Shaffer <emilyshaffer@google.com>
Date
Jun 20, 2019, 21:29 UTC
Message-ID
<20190620212922.GB87385@google.com>
In-Reply-To
<20190619221315.7343-1-chriscool@tuxfamily.org>
On Thu, Jun 20, 2019 at 12:13:15AM +0200, Christian Couder wrote:
Show 5 quoted lines
>  SYNOPSIS
>  --------
>  [verse]
> -'git-psuh'
> +'git-psuh <arg>...'

It doesn't require 1 or more args - you can run it with no args. So it might be better suited to state the args as optional:

  'git psuh [arg]...'
>  ----
>  static const char * const psuh_usage[] = {
> -	N_("git psuh"),
> +	N_("git psuh <arg>..."),
...and here too.
 - Emily
Previous: Christian CouderNext: Christian Couder
Message 2 of 6 in “doc: improve usage string in MyFirstContribution”
  1. doc: improve usage string in MyFirstContributionChristian Couder, Jun 19, 2019
  2. Emily ShafferJun 20, 2019
  3. Christian CouderJun 21, 2019
  4. Eric SunshineJun 21, 2019
  5. Junio C HamanoJun 21, 2019
  6. Eric SunshineJun 21, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.