aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJean-Noël Avila <jn.avila@free.fr>2025-01-15 20:23:45 +0000
committerJunio C Hamano <gitster@pobox.com>2025-01-15 14:43:36 -0800
commitd533c1069724d39153f5ae78f2c3a3f2b6a5a6e2 (patch)
tree4f11151baaa3db01144aa349f1e21a841d8fc071
parentdoc: apply new documentation guidelines to git commit (diff)
downloadgit-d533c1069724d39153f5ae78f2c3a3f2b6a5a6e2.tar.gz
git-d533c1069724d39153f5ae78f2c3a3f2b6a5a6e2.zip
doc: the mode param of -u of git commit is optional
Fix the synopsis to reflect the option description. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-commit.txt2
-rw-r--r--builtin/commit.c2
2 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index e37c4a4987..f5d702205d 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -8,7 +8,7 @@ git-commit - Record changes to the repository
SYNOPSIS
--------
[synopsis]
-git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
+git commit [-a | --interactive | --patch] [-s] [-v] [-u[<mode>]] [--amend]
[--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]
[-F <file> | -m <msg>] [--reset-author] [--allow-empty]
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
diff --git a/builtin/commit.c b/builtin/commit.c
index ef5e622c07..a7315ed67c 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -44,7 +44,7 @@
#include "trailer.h"
static const char * const builtin_commit_usage[] = {
- N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]\n"
+ N_("git commit [-a | --interactive | --patch] [-s] [-v] [-u[<mode>]] [--amend]\n"
" [--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>]\n"
" [-F <file> | -m <msg>] [--reset-author] [--allow-empty]\n"
" [--allow-empty-message] [--no-verify] [-e] [--author=<author>]\n"