From: Junio C Hamano <gitster@pobox.com>
To: Han-Wen Nienhuys <hanwen@google.com>
Cc: Han-Wen Nienhuys via GitGitGadget <gitgitgadget@gmail.com>,
git@vger.kernel.org, Han-Wen Nienhuys <hanwenn@gmail.com>
Subject: Re* [PATCH 2/4] refs: trim newline from reflog message
Date: Fri, 26 Nov 2021 00:35:17 -0800 [thread overview]
Message-ID: <xmqqczmn71ru.fsf_-_@gitster.g> (raw)
In-Reply-To: <xmqqzgpu7grv.fsf@gitster.g> (Junio C. Hamano's message of "Tue, 23 Nov 2021 12:34:28 -0800")
Junio C Hamano <gitster@pobox.com> writes:
> I think what deserves such a comment more is the prototype for
> each_reflog_ent_fn describing what the parameters to that callback
> function, to help the callers of the iterator what to expect. That
> is the end-user facing part.
Perhaps something along this line.
--- >8 ------ >8 ------ >8 ------ >8 ------ >8 ------ >8 ---
Subject: [PATCH] refs: document callback for reflog-ent iterators
refs_for_each_reflog_ent() and refs_for_each_reflog_ent_reverse()
functions take a callback function that gets called with the details
of each reflog entry. Its parameters were not documented beyond
their names. Elaborate a bit on each of them.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
refs.h | 22 +++++++++++++++++++++-
1 file changed, 21 insertions(+), 1 deletion(-)
diff --git c/refs.h w/refs.h
index 48970dfc7e..4fa97d77cf 100644
--- c/refs.h
+++ w/refs.h
@@ -462,7 +462,27 @@ int delete_reflog(const char *refname);
/*
* Callback to process a reflog entry found by the iteration functions (see
- * below)
+ * below).
+ *
+ * The committer parameter is a single string, in the form
+ * "$GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>" (without double quotes).
+ *
+ * The timestamp parameter gives the seconds since epoch when the reflog
+ * entry was created.
+ *
+ * The tz parameter is an up to 4 digits integer, whose absolute value
+ * gives the hour and minute offset from GMT (the lower 2 digits are
+ * minutes, the higher 2 digits are hours). A negative tz means west of,
+ * and a positive tz means east of GMT.
+ *
+ * The msg parameter is a single complete line; a reflog message given
+ * to refs_delete_ref, refs_update_ref, etc. is returned to the
+ * callback normalized---each run of whitespaces are squashed into a
+ * single whitespace, trailing whitespace, if exists, is trimmed, and
+ * then a single LF is added at the end.
+ *
+ * The cb_data is a caller-supplied pointer given to the iterator
+ * functions.
*/
typedef int each_reflog_ent_fn(
struct object_id *old_oid, struct object_id *new_oid,
next prev parent reply other threads:[~2021-11-26 8:37 UTC|newest]
Thread overview: 60+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-22 14:20 [PATCH 0/4] Inspect reflog data programmatically in more tests Han-Wen Nienhuys via GitGitGadget
2021-11-22 14:20 ` [PATCH 1/4] show-branch: show reflog message Han-Wen Nienhuys via GitGitGadget
2021-11-22 22:22 ` Junio C Hamano
2021-11-23 7:40 ` Bagas Sanjaya
2021-11-23 8:03 ` Elijah Newren
2021-11-22 14:20 ` [PATCH 2/4] refs: trim newline from " Han-Wen Nienhuys via GitGitGadget
2021-11-22 22:27 ` Junio C Hamano
2021-11-23 16:35 ` Han-Wen Nienhuys
2021-11-23 17:09 ` Junio C Hamano
2021-11-23 17:28 ` Han-Wen Nienhuys
2021-11-23 20:34 ` Junio C Hamano
2021-11-24 11:17 ` Han-Wen Nienhuys
2021-11-24 18:53 ` Junio C Hamano
2021-11-24 19:06 ` Han-Wen Nienhuys
2021-11-24 20:55 ` Junio C Hamano
2021-11-25 16:00 ` Han-Wen Nienhuys
2021-11-29 2:30 ` Junio C Hamano
2021-11-24 19:26 ` Junio C Hamano
2021-11-24 19:39 ` Han-Wen Nienhuys
2021-11-26 8:35 ` Junio C Hamano [this message]
2021-11-28 17:50 ` Re* " Ævar Arnfjörð Bjarmason
2021-11-28 18:59 ` Junio C Hamano
2021-11-28 19:25 ` Junio C Hamano
2021-11-29 8:39 ` Ævar Arnfjörð Bjarmason
2021-11-23 10:24 ` Ævar Arnfjörð Bjarmason
2021-11-23 16:44 ` Han-Wen Nienhuys
2021-11-22 14:20 ` [PATCH 3/4] test-ref-store: tweaks to for-each-reflog-ent format Han-Wen Nienhuys via GitGitGadget
2021-11-22 22:31 ` Junio C Hamano
2021-11-23 17:06 ` Han-Wen Nienhuys
2021-11-23 18:31 ` Junio C Hamano
2021-11-22 14:20 ` [PATCH 4/4] t1400: use test-helper ref-store to inspect reflog contents Han-Wen Nienhuys via GitGitGadget
2021-11-22 15:20 ` Ævar Arnfjörð Bjarmason
2021-11-22 17:07 ` Han-Wen Nienhuys
2021-11-22 22:22 ` Junio C Hamano
2021-11-25 15:57 ` [PATCH v2 0/5] Inspect reflog data programmatically in more tests Han-Wen Nienhuys via GitGitGadget
2021-11-25 15:57 ` [PATCH v2 1/5] show-branch: show reflog message Han-Wen Nienhuys via GitGitGadget
2021-11-25 15:57 ` [PATCH v2 2/5] test-ref-store: don't add newline to " Han-Wen Nienhuys via GitGitGadget
2021-11-26 7:56 ` Junio C Hamano
2021-11-25 15:57 ` [PATCH v2 3/5] t1405: check for_each_reflog_ent_reverse() more thoroughly Han-Wen Nienhuys via GitGitGadget
2021-11-25 15:57 ` [PATCH v2 4/5] test-ref-store: tweaks to for-each-reflog-ent format Han-Wen Nienhuys via GitGitGadget
2021-11-26 8:02 ` Junio C Hamano
2021-11-25 15:57 ` [PATCH v2 5/5] refs/debug: trim trailing LF from reflog message Han-Wen Nienhuys via GitGitGadget
2021-11-26 8:16 ` Junio C Hamano
2021-11-29 18:29 ` Han-Wen Nienhuys
2021-11-29 19:19 ` Junio C Hamano
2021-11-29 19:35 ` Junio C Hamano
2021-12-02 16:24 ` Han-Wen Nienhuys
2021-12-02 18:36 ` Junio C Hamano
2021-11-29 20:59 ` Ævar Arnfjörð Bjarmason
2021-11-29 9:50 ` [PATCH v2 0/5] Inspect reflog data programmatically in more tests Ævar Arnfjörð Bjarmason
2021-11-29 18:24 ` Han-Wen Nienhuys
2021-11-29 22:30 ` Junio C Hamano
2021-11-29 23:28 ` Ævar Arnfjörð Bjarmason
2021-12-02 16:11 ` Han-Wen Nienhuys
2021-12-02 17:36 ` [PATCH v3 " Han-Wen Nienhuys via GitGitGadget
2021-12-02 17:36 ` [PATCH v3 1/5] show-branch: show reflog message Han-Wen Nienhuys via GitGitGadget
2021-12-02 17:36 ` [PATCH v3 2/5] test-ref-store: don't add newline to " Han-Wen Nienhuys via GitGitGadget
2021-12-02 17:36 ` [PATCH v3 3/5] t1405: check for_each_reflog_ent_reverse() more thoroughly Han-Wen Nienhuys via GitGitGadget
2021-12-02 17:36 ` [PATCH v3 4/5] test-ref-store: tweaks to for-each-reflog-ent format Han-Wen Nienhuys via GitGitGadget
2021-12-02 17:36 ` [PATCH v3 5/5] refs/debug: trim trailing LF from reflog message Han-Wen Nienhuys via GitGitGadget
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqczmn71ru.fsf_-_@gitster.g \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=hanwen@google.com \
--cc=hanwenn@gmail.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).