aboutsummaryrefslogtreecommitdiffstats
path: root/builtin/for-each-ref.c
diff options
context:
space:
mode:
authorMeet Soni <meetsoni3017@gmail.com>2025-08-05 14:57:54 +0530
committerJunio C Hamano <gitster@pobox.com>2025-08-05 09:11:54 -0700
commit69c207dc45c0e95bff2bdcaf1c7aca41e9679fb8 (patch)
tree55dceadb973d007b862107139068b8c0a4bb4b11 /builtin/for-each-ref.c
parent19623eb97e4edf76d585100c605037f9e51f6987 (diff)
downloadgit-69c207dc45c0e95bff2bdcaf1c7aca41e9679fb8.tar.gz
builtin/for-each-ref: align usage string with the man page
Usage string for `git for-each-ref` was out of sync with its official documentation. The test `t0450-txt-doc-vs-help.sh` was marked as broken due to this. Update the usage string to match the documentation. This allows the test to pass, so remove the corresponding 'known breakage' marker from the test file. Mentored-by: Patrick Steinhardt <ps@pks.im> Mentored-by: shejialuo <shejialuo@gmail.com> Mentored-by: Karthik Nayak <karthik.188@gmail.com> Signed-off-by: Meet Soni <meetsoni3017@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'builtin/for-each-ref.c')
-rw-r--r--builtin/for-each-ref.c15
1 files changed, 10 insertions, 5 deletions
diff --git a/builtin/for-each-ref.c b/builtin/for-each-ref.c
index 8b5fe7b65e..fe62f07861 100644
--- a/builtin/for-each-ref.c
+++ b/builtin/for-each-ref.c
@@ -9,12 +9,17 @@
#include "strbuf.h"
#include "strvec.h"
+#define COMMON_USAGE_FOR_EACH_REF \
+ "[--count=<count>] [--shell|--perl|--python|--tcl]\n" \
+ " [(--sort=<key>)...] [--format=<format>]\n" \
+ " [--include-root-refs] [--points-at=<object>]\n" \
+ " [--merged[=<object>]] [--no-merged[=<object>]]\n" \
+ " [--contains[=<object>]] [--no-contains[=<object>]]\n" \
+ " [(--exclude=<pattern>)...] [--start-after=<marker>]\n" \
+ " [ --stdin | <pattern>... ]"
+
static char const * const for_each_ref_usage[] = {
- N_("git for-each-ref [<options>] [<pattern>]"),
- N_("git for-each-ref [--points-at <object>]"),
- N_("git for-each-ref [--merged [<commit>]] [--no-merged [<commit>]]"),
- N_("git for-each-ref [--contains [<commit>]] [--no-contains [<commit>]]"),
- N_("git for-each-ref [--start-after <marker>]"),
+ "git for-each-ref " COMMON_USAGE_FOR_EACH_REF,
NULL
};