{"thread":{"id":"65384","subject":"[GSoC PATCH] bugreport: clarify usage message purpose","startedAt":"2026-03-30T06:45:47Z","lastAt":"2026-03-30T20:08:48Z","messageCount":7,"participants":["Smaran Jaianand","Karthik Nayak","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"540354","messageId":"20260330064454.76833-1-24070721037@sithyd.siu.edu.in","threadId":"65384","inReplyTo":null,"subject":"[GSoC PATCH] bugreport: clarify usage message purpose","fromName":"Smaran Jaianand","fromEmail":"24070721037@sithyd.siu.edu.in","sentAt":"2026-03-30T06:44:44Z","receivedAt":"2026-03-30T06:45:47Z","isPatch":true,"body":"From: smaran-jaianand <24070721037@sithyd.siu.edu.in>\n\nAdd a brief description of the bugreport command to improve\nclarity of the usage message.\n\nSigned-off-by: smaran-jaianand <24070721037@sithyd.siu.edu.in>\n---\n builtin/bugreport.c | 3 ++-\n 1 file changed, 2 insertions(+), 1 deletion(-)\n\ndiff --git a/builtin/bugreport.c b/builtin/bugreport.c\nindex f78c3f2aed..3b3fdd4dfb 100644\n--- a/builtin/bugreport.c\n+++ b/builtin/bugreport.c\n@@ -56,7 +56,8 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)\n }\n \n static const char * const bugreport_usage[] = {\n-\tN_(\"git bugreport [(-o | --output-directory) ]\\n\"\n+\tN_(\"git bugreport -create a bug report with diagnostic information \\n\"\n+ \" [(-o | --output-directory) ]\\n\"\n \t \" [(-s | --suffix) | --no-suffix]\\n\"\n \t \" [--diagnose[=]]\"),\n \tNULL\n-- \n2.43.0\n\n\n-- \n* * \n \n \n \n \n\n\n\n\n**Disclaimer:* This email is \ngoverned by the Disclaimer Terms of SIU, which may be viewed at \nhttp://siu.edu.in/disclaimer.php *\n\n\n"},{"id":"540355","messageId":"20260330065053.76919-3-24070721037@sithyd.siu.edu.in","threadId":"65384","inReplyTo":"20260330064454.76833-1-24070721037@sithyd.siu.edu.in","subject":"[GSoC PATCH v2] bugreport: clarify usage message purpose","fromName":"Smaran Jaianand","fromEmail":"24070721037@sithyd.siu.edu.in","sentAt":"2026-03-30T06:50:36Z","receivedAt":"2026-03-30T06:53:27Z","isPatch":true,"body":"From: smaran-jaianand <24070721037@sithyd.siu.edu.in>\n\nv2: Fix spacing in usage message (add missing space and remove trailing whitespace).\n\nAdd a brief description of the bugreport command to improve\nclarity of the usage message.\n\nSigned-off-by: smaran-jaianand <24070721037@sithyd.siu.edu.in>\nSigned-off-by: Smaran Jaianand <24070721037@sithyd.siu.edu.in>\n---\n builtin/bugreport.c | 3 ++-\n 1 file changed, 2 insertions(+), 1 deletion(-)\n\ndiff --git a/builtin/bugreport.c b/builtin/bugreport.c\nindex f78c3f2aed..6b1d1accb1 100644\n--- a/builtin/bugreport.c\n+++ b/builtin/bugreport.c\n@@ -56,7 +56,8 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)\n }\n \n static const char * const bugreport_usage[] = {\n-\tN_(\"git bugreport [(-o | --output-directory) ]\\n\"\n+\tN_(\"git bugreport - create a bug report with diagnostic information\\n\"\n+ \" [(-o | --output-directory) ]\\n\"\n \t \" [(-s | --suffix) | --no-suffix]\\n\"\n \t \" [--diagnose[=]]\"),\n \tNULL\n-- \n2.43.0\n\n\n-- \n* * \n \n \n \n \n\n\n\n\n**Disclaimer:* This email is \ngoverned by the Disclaimer Terms of SIU, which may be viewed at \nhttp://siu.edu.in/disclaimer.php *\n\n\n"},{"id":"540356","messageId":"CAOLa=ZTMEJCQn2RDsLmVzPkh1s97K10bpCaCSF44MbbfnVXEvQ@mail.gmail.com","threadId":"65384","inReplyTo":"20260330065053.76919-3-24070721037@sithyd.siu.edu.in","subject":"Re: [GSoC PATCH v2] bugreport: clarify usage message purpose","fromName":"Karthik Nayak","fromEmail":"karthik.188@gmail.com","sentAt":"2026-03-30T09:32:12Z","receivedAt":"2026-03-30T09:32:14Z","isPatch":true,"body":"Smaran Jaianand <24070721037@sithyd.siu.edu.in> writes:\n\n> From: smaran-jaianand <24070721037@sithyd.siu.edu.in>\n>\n> v2: Fix spacing in usage message (add missing space and remove\n> trailing whitespace).\n\nVersion related changes should either go into the cover letter or below\nthe '---' in the commit. I would recommend reading the following\ndocumentation\n\n - Documentation/SubmittingPatches\n - Documentation/CodingGuidelines\n - Documentation/MyFirstContribution.adoc\n\n>\n> Add a brief description of the bugreport command to improve\n> clarity of the usage message.\n>\n\nThe git command adds command description to the 'NAME' header within the\ndocumentation. For 'git-bugreport(1)' you can find this in\n'Documentation/git-bugreport.adoc'.\n\n> Signed-off-by: smaran-jaianand <24070721037@sithyd.siu.edu.in>\n> Signed-off-by: Smaran Jaianand <24070721037@sithyd.siu.edu.in>\n\n> ---\n> builtin/bugreport.c | 3 ++-\n> 1 file changed, 2 insertions(+), 1 deletion(-)\n>\n> diff --git a/builtin/bugreport.c b/builtin/bugreport.c\n> index f78c3f2aed..6b1d1accb1 100644\n> --- a/builtin/bugreport.c\n> +++ b/builtin/bugreport.c\n> @@ -56,7 +56,8 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)\n> }\n>\n> static const char * const bugreport_usage[] = {\n> -\tN_(\"git bugreport [(-o | --output-directory) ]\\n\"\n> +\tN_(\"git bugreport - create a bug report with diagnostic information\\n\"\n> + \" [(-o | --output-directory) ]\\n\"\n> \t \" [(-s | --suffix) | --no-suffix]\\n\"\n> \t \" [--diagnose[=]]\"),\n> \tNULL\n> --\n> 2.43.0\n>\n>\n> --\n> * *\n> \n> \n> \n>\n>\n>\n>\n>\n> **Disclaimer:* This email is\n> governed by the Disclaimer Terms of SIU, which may be viewed at\n> http://siu.edu.in/disclaimer.php *\n"},{"id":"540390","messageId":"xmqqjyutfjrd.fsf@gitster.g","threadId":"65384","inReplyTo":"20260330064454.76833-1-24070721037@sithyd.siu.edu.in","subject":"Re: [GSoC PATCH] bugreport: clarify usage message purpose","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2026-03-30T14:56:54Z","receivedAt":"2026-03-30T14:56:56Z","isPatch":true,"body":"Smaran Jaianand <24070721037@sithyd.siu.edu.in> writes:\n\n> From: smaran-jaianand <24070721037@sithyd.siu.edu.in>\n>\n> Add a brief description of the bugreport command to improve\n> clarity of the usage message.\n>\n> Signed-off-by: smaran-jaianand <24070721037@sithyd.siu.edu.in>\n> ---\n> builtin/bugreport.c | 3 ++-\n> 1 file changed, 2 insertions(+), 1 deletion(-)\n>\n> diff --git a/builtin/bugreport.c b/builtin/bugreport.c\n> index f78c3f2aed..3b3fdd4dfb 100644\n> --- a/builtin/bugreport.c\n> +++ b/builtin/bugreport.c\n> @@ -56,7 +56,8 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)\n> }\n> \n> static const char * const bugreport_usage[] = {\n> -\tN_(\"git bugreport [(-o | --output-directory) ]\\n\"\n> +\tN_(\"git bugreport -create a bug report with diagnostic information \\n\"\n> + \" [(-o | --output-directory) ]\\n\"\n> \t \" [(-s | --suffix) | --no-suffix]\\n\"\n> \t \" [--diagnose[=]]\"),\n> \tNULL\n> -- \n> 2.43.0\n\nThis is wrong. The usage string is to show \"usage\". Unless your\nusers type\n\n $ git bugreport -create a bug ...\n\nfrom their command line, the first line that you added does not\nbelong there.\n\nIn general, these should match what is in the synopsis section of\nthe manpage (i.e., \"git help bugreport\" output), and there is even\na test to ensure they do not diverge from each other (iirc, t0450).\n\n"},{"id":"540415","messageId":"20260330174131.456-3-24070721037@sithyd.siu.edu.in","threadId":"65384","inReplyTo":"20260330064454.76833-1-24070721037@sithyd.siu.edu.in","subject":"[GSoC PATCH v3] bugreport: revert incorrect usage message change","fromName":"Smaran Jaianand","fromEmail":"24070721037@sithyd.siu.edu.in","sentAt":"2026-03-30T17:41:08Z","receivedAt":"2026-03-30T18:07:37Z","isPatch":true,"body":"From: smaran-jaianand <24070721037@sithyd.siu.edu.in>\n\nThe usage string is intended to reflect command syntax rather than\ndescribe functionality. Revert the previous change to keep it consistent\nwith documentation.\n\nSigned-off-by: Smaran Jaianand <24070721037@sithyd.siu.edu.in>\n---\nv3: Revert previous change after feedback that usage strings should reflect command syntax rather than description.\n\n builtin/bugreport.c | 3 ++-\n 1 file changed, 2 insertions(+), 1 deletion(-)\n\ndiff --git a/builtin/bugreport.c b/builtin/bugreport.c\nindex f78c3f2aed..6b1d1accb1 100644\n--- a/builtin/bugreport.c\n+++ b/builtin/bugreport.c\n@@ -56,7 +56,8 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)\n }\n \n static const char * const bugreport_usage[] = {\n-\tN_(\"git bugreport [(-o | --output-directory) ]\\n\"\n+\tN_(\"git bugreport - create a bug report with diagnostic information\\n\"\n+ \" [(-o | --output-directory) ]\\n\"\n \t \" [(-s | --suffix) | --no-suffix]\\n\"\n \t \" [--diagnose[=]]\"),\n \tNULL\n-- \n2.43.0\n\n\n-- \n* * \n \n \n \n \n\n\n\n\n**Disclaimer:* This email is \ngoverned by the Disclaimer Terms of SIU, which may be viewed at \nhttp://siu.edu.in/disclaimer.php *\n\n\n"},{"id":"540416","messageId":"20260330174131.456-5-24070721037@sithyd.siu.edu.in","threadId":"65384","inReplyTo":"20260330064454.76833-1-24070721037@sithyd.siu.edu.in","subject":"[GSoC PATCH v3] bugreport: revert incorrect usage message change","fromName":"Smaran Jaianand","fromEmail":"24070721037@sithyd.siu.edu.in","sentAt":"2026-03-30T17:41:10Z","receivedAt":"2026-03-30T18:08:39Z","isPatch":true,"body":"Revert the previous change to keep it consistent with documentation.\nBased on the feedback, the usage string is intended to represent command syntax rather than provide a description.\n\nSigned-off-by: Smaran Jaianand <24070721037@sithyd.siu.edu.in>\n---\n builtin/bugreport.c | 3 +--\n 1 file changed, 1 insertion(+), 2 deletions(-)\n\ndiff --git a/builtin/bugreport.c b/builtin/bugreport.c\nindex 6b1d1accb1..c42b61cc8f 100644\n--- a/builtin/bugreport.c\n+++ b/builtin/bugreport.c\n@@ -56,8 +56,7 @@ static void get_populated_hooks(struct strbuf *hook_info, int nongit)\n }\n \n static const char * const bugreport_usage[] = {\n-\tN_(\"git bugreport - create a bug report with diagnostic information\\n\"\n- \" [(-o | --output-directory) ]\\n\"\n+\tN_(\" [(-o | --output-directory) ]\\n\"\n \t \" [(-s | --suffix) | --no-suffix]\\n\"\n \t \" [--diagnose[=]]\"),\n \tNULL\n-- \n2.43.0\n\n\n-- \n* * \n \n \n \n \n\n\n\n\n**Disclaimer:* This email is \ngoverned by the Disclaimer Terms of SIU, which may be viewed at \nhttp://siu.edu.in/disclaimer.php *\n\n\n"},{"id":"540424","messageId":"xmqqldf9dqr6.fsf@gitster.g","threadId":"65384","inReplyTo":"20260330174131.456-5-24070721037@sithyd.siu.edu.in","subject":"Re: [GSoC PATCH v3] bugreport: revert incorrect usage message change","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2026-03-30T20:08:45Z","receivedAt":"2026-03-30T20:08:48Z","isPatch":true,"body":"Smaran Jaianand <24070721037@sithyd.siu.edu.in> writes:\n\n> Revert the previous change to keep it consistent with documentation.\n> Based on the feedback, the usage string is intended to represent command syntax rather than provide a description.\n\nYou really do not have to post a patch to revert something that was\nrejected and did not get applied anywhere to our tree.\n\nWe frown upon a patch series that makes mistakes in an earlier step,\nonly to fix them in a later step. The \"git rebase -i\" command helps\nus pretend to be more perfect developers than we actually are,\nwhipping your patch series into a shape that builds one small step\non top of another in a logical succession. Such a patch series is\neasier to understand than a history that faithfully records all the\nstumbles the developer made until they reached the final solution.\n\nIf you rebuilt your changes, while removing any parts that shouldn't\nbe there, in an effort to pretend to be a more perfect developer,\nsometimes you might end up with an empty patch, and that is OK. You\ncan just send a message that you are retracting the earlier patch\nand everybody would understand.\n\nThanks.\n\n\n\n"}]}