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

Re: [GSoC PATCH v2] bugreport: clarify usage message purpose

From
Karthik Nayak <karthik.188@gmail.com>
Date
Mar 30, 2026, 09:32 UTC
Message-ID
<CAOLa=ZTMEJCQn2RDsLmVzPkh1s97K10bpCaCSF44MbbfnVXEvQ@mail.gmail.com>
In-Reply-To
<20260330065053.76919-3-24070721037@sithyd.siu.edu.in>
Smaran Jaianand <24070721037@sithyd.siu.edu.in> writes:
> From: smaran-jaianand <24070721037@sithyd.siu.edu.in>
>
> v2: Fix spacing in usage message (add missing space and remove
> trailing whitespace).

Version related changes should either go into the cover letter or below the '---' in the commit. I would recommend reading the following documentation

  - Documentation/SubmittingPatches
  - Documentation/CodingGuidelines
  - Documentation/MyFirstContribution.adoc
>
> Add a brief description of the bugreport command to improve
> clarity of the usage message.
>

The git command adds command description to the 'NAME' header within the documentation. For 'git-bugreport(1)' you can find this in 'Documentation/git-bugreport.adoc'.

> Signed-off-by: smaran-jaianand <24070721037@sithyd.siu.edu.in>
> Signed-off-by: Smaran Jaianand <24070721037@sithyd.siu.edu.in>
Show 35 quoted lines
> ---
>  builtin/bugreport.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/builtin/bugreport.c b/builtin/bugreport.c
> index f78c3f2aed..6b1d1accb1 100644
> --- a/builtin/bugreport.c
> +++ b/builtin/bugreport.c
> @@ -56,7 +56,8 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)
>  }
>
>  static const char * const bugreport_usage[] = {
> -	N_("git bugreport [(-o | --output-directory) <path>]\n"
> +	N_("git bugreport - create a bug report with diagnostic information\n"
> +           "              [(-o | --output-directory) <path>]\n"
>  	   "              [(-s | --suffix) <format> | --no-suffix]\n"
>  	   "              [--diagnose[=<mode>]]"),
>  	NULL
> --
> 2.43.0
>
>
> --
> * <https://www.facebook.com/symbiosis.official/>*
> <https://www.instagram.com/symbiosis.official/>
> <https://www.linkedin.com/school/symbiosis-international-university/>
> <https://x.com/symbiosistweets>
>
>
>
>
>
> **Disclaimer:* This email is
> governed by the Disclaimer Terms of SIU, which may be viewed at
> http://siu.edu.in/disclaimer.php <http://siu.edu.in/disclaimer.php>*
Previous: Smaran JaianandNext: Junio C Hamano
Message 3 of 7 in “bugreport: clarify usage message purpose”
  1. bugreport: clarify usage message purposeSmaran Jaianand, Mar 30, 2026
  2. bugreport: clarify usage message purposeSmaran Jaianand, Mar 30, 2026
  3. Karthik NayakMar 30, 2026
  4. Junio C HamanoMar 30, 2026
  5. bugreport: revert incorrect usage message changeSmaran Jaianand, Mar 30, 2026
  6. bugreport: revert incorrect usage message changeSmaran Jaianand, Mar 30, 2026
  7. Junio C HamanoMar 30, 2026

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.