From 067622b0e8afde8b39884e221b7a56299036f6d9 Mon Sep 17 00:00:00 2001 From: Michael Haggerty Date: Sat, 18 Jun 2016 06:15:08 +0200 Subject: do_for_each_ref(): move docstring to the header file Signed-off-by: Michael Haggerty Signed-off-by: Junio C Hamano --- refs/refs-internal.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'refs/refs-internal.h') diff --git a/refs/refs-internal.h b/refs/refs-internal.h index 1bb3d87dc5..b4dd5453ea 100644 --- a/refs/refs-internal.h +++ b/refs/refs-internal.h @@ -249,7 +249,15 @@ int rename_ref_available(const char *oldname, const char *newname); #define DO_FOR_EACH_INCLUDE_BROKEN 0x01 /* - * The common backend for the for_each_*ref* functions + * Call fn for each reference in the specified submodule for which the + * refname begins with base. If trim is non-zero, then trim that many + * characters off the beginning of each refname before passing the + * refname to fn. flags can be DO_FOR_EACH_INCLUDE_BROKEN to include + * broken references in the iteration. If fn ever returns a non-zero + * value, stop the iteration and return that value; otherwise, return + * 0. + * + * This is the common backend for the for_each_*ref* functions. */ int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn, int trim, int flags, void *cb_data); -- cgit v1.2.3