aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-bugreport.txt
diff options
context:
space:
mode:
authorJean-Noël Avila <jn.avila@free.fr>2023-12-25 21:21:26 +0000
committerJunio C Hamano <gitster@pobox.com>2023-12-26 11:06:55 -0800
commit2162f9f6f86df4f49c3a716b5beb3952104ea8b8 (patch)
tree9f0fec3c23e0ef98bbb46ec8ceec200355330c89 /Documentation/git-bugreport.txt
parent055bb6e9969085777b7fab83e3fee0017654f134 (diff)
downloadgit-2162f9f6f86df4f49c3a716b5beb3952104ea8b8.tar.gz
doc: enforce dashes in placeholders
The CodingGuidelines documents stipulates that multi-word placeholders are to be separated by dashes, not underscores nor spaces. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-bugreport.txt')
-rw-r--r--Documentation/git-bugreport.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt
index 392d9eb6ae..ca626f7fc6 100644
--- a/Documentation/git-bugreport.txt
+++ b/Documentation/git-bugreport.txt
@@ -52,7 +52,7 @@ OPTIONS
-s <format>::
--suffix <format>::
Specify an alternate suffix for the bugreport name, to create a file
- named 'git-bugreport-<formatted suffix>'. This should take the form of a
+ named 'git-bugreport-<formatted-suffix>'. This should take the form of a
strftime(3) format string; the current local time will be used.
--no-diagnose::
@@ -60,7 +60,7 @@ OPTIONS
Create a zip archive of supplemental information about the user's
machine, Git client, and repository state. The archive is written to the
same output directory as the bug report and is named
- 'git-diagnostics-<formatted suffix>'.
+ 'git-diagnostics-<formatted-suffix>'.
+
Without `mode` specified, the diagnostic archive will contain the default set of
statistics reported by `git diagnose`. An optional `mode` value may be specified