From: "Jiamu Sun via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: barroit <barroit@linux.com>, Jiamu Sun <barroit@linux.com>
Subject: [PATCH v2 2/2] doc: update doc file and usage for git-bugreport
Date: Thu, 14 Mar 2024 04:00:17 +0000 [thread overview]
Message-ID: <868cec05ed53e780660d98c08b5a306af3cc363e.1710388817.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1693.v2.git.1710388817.gitgitgadget@gmail.com>
From: Jiamu Sun <barroit@linux.com>
Changes since v1:
- Update documentation and usage string for `git bugreport` as
suggested by Junio C Hamano
Signed-off-by: Jiamu Sun <barroit@linux.com>
---
Documentation/git-bugreport.txt | 6 +++++-
builtin/bugreport.c | 3 ++-
2 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt
index ca626f7fc68..112658b3c3b 100644
--- a/Documentation/git-bugreport.txt
+++ b/Documentation/git-bugreport.txt
@@ -8,7 +8,8 @@ git-bugreport - Collect information for user to file a bug report
SYNOPSIS
--------
[verse]
-'git bugreport' [(-o | --output-directory) <path>] [(-s | --suffix) <format>]
+'git bugreport' [(-o | --output-directory) <path>]
+ [(-s | --suffix) <format> | --no-suffix]
[--diagnose[=<mode>]]
DESCRIPTION
@@ -51,9 +52,12 @@ OPTIONS
-s <format>::
--suffix <format>::
+--no-suffix::
Specify an alternate suffix for the bugreport name, to create a file
named 'git-bugreport-<formatted-suffix>'. This should take the form of a
strftime(3) format string; the current local time will be used.
+ `--no-suffix` disables the suffix and the file is just named
+ `git-bugreport` without any disambiguation measure.
--no-diagnose::
--diagnose[=<mode>]::
diff --git a/builtin/bugreport.c b/builtin/bugreport.c
index 32281815b77..25f860a0d97 100644
--- a/builtin/bugreport.c
+++ b/builtin/bugreport.c
@@ -64,7 +64,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>] [(-s | --suffix) <format>]\n"
+ N_("git bugreport [(-o | --output-directory) <path>]\n"
+ " [(-s | --suffix) <format> | --no-suffix]\n"
" [--diagnose[=<mode>]]"),
NULL
};
--
gitgitgadget
next prev parent reply other threads:[~2024-03-14 4:00 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-12 16:26 [PATCH] bugreport.c: fix a crash in `git bugreport` with `--no-suffix` option barroit via GitGitGadget
2024-03-13 15:59 ` Junio C Hamano
2024-03-13 17:42 ` Junio C Hamano
2024-03-16 1:55 ` Taylor Blau
2024-03-14 4:00 ` [PATCH v2 0/2] bugreport.c: fix a crash in git bugreport with --no-suffix option barroit via GitGitGadget
2024-03-14 4:00 ` [PATCH v2 1/2] bugreport.c: fix a crash in `git bugreport` with `--no-suffix` option Jiamu Sun via GitGitGadget
2024-03-14 4:00 ` Jiamu Sun via GitGitGadget [this message]
2024-03-14 16:27 ` [PATCH v2 0/2] bugreport.c: fix a crash in git bugreport with --no-suffix option Junio C Hamano
2024-03-14 16:33 ` Junio C Hamano
2024-03-15 22:42 ` [PATCH v3] " Jiamu Sun
2024-03-14 22:34 ` [PATCH v3] bugreport.c: fix a crash in `git bugreport` with `--no-suffix` option Jiamu Sun
2024-03-16 1:56 ` Taylor Blau
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=868cec05ed53e780660d98c08b5a306af3cc363e.1710388817.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=barroit@linux.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).