From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>, "Jeff King" <peff@peff.net>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH v2 4/5] date API: add basic API docs
Date: Sat, 5 Feb 2022 00:53:05 +0100 [thread overview]
Message-ID: <patch-v2-4.5-3f70b1aa4c5-20220204T235143Z-avarab@gmail.com> (raw)
In-Reply-To: <cover-v2-0.5-00000000000-20220204T235143Z-avarab@gmail.com>
Add basic API doc comments to date.h, and while doing so move the the
parse_date_format() function adjacent to show_date(). This way all the
"struct date_mode" functions are grouped together. Documenting the
rest is one of our #leftoverbits.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
date.h | 23 +++++++++++++++++++++--
1 file changed, 21 insertions(+), 2 deletions(-)
diff --git a/date.h b/date.h
index c3a00d08ed6..4ed83506de9 100644
--- a/date.h
+++ b/date.h
@@ -1,6 +1,12 @@
#ifndef DATE_H
#define DATE_H
+/**
+ * The date mode type. This has DATE_NORMAL at an explicit "= 0" to
+ * accommodate a memset([...], 0, [...]) initialization when "struct
+ * date_mode" is used as an embedded struct member, as in the case of
+ * e.g. "struct pretty_print_context" and "struct rev_info".
+ */
enum date_mode_type {
DATE_NORMAL = 0,
DATE_HUMAN,
@@ -24,7 +30,7 @@ struct date_mode {
.type = DATE_NORMAL, \
}
-/*
+/**
* Convenience helper for passing a constant type, like:
*
* show_date(t, tz, DATE_MODE(NORMAL));
@@ -32,7 +38,21 @@ struct date_mode {
#define DATE_MODE(t) date_mode_from_type(DATE_##t)
struct date_mode *date_mode_from_type(enum date_mode_type type);
+/**
+ * Show the date given an initialized "struct date_mode" (usually from
+ * the DATE_MODE() macro).
+ */
const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);
+
+/**
+ * Parse a date format for later use with show_date().
+ *
+ * When the "date_mode_type" is DATE_STRFTIME the "strftime_fmt"
+ * member of "struct date_mode" will be a malloc()'d format string to
+ * be used with strbuf_addftime().
+ */
+void parse_date_format(const char *format, struct date_mode *mode);
+
void show_date_relative(timestamp_t time, struct strbuf *timebuf);
int parse_date(const char *date, struct strbuf *out);
int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);
@@ -41,7 +61,6 @@ void datestamp(struct strbuf *out);
#define approxidate(s) approxidate_careful((s), NULL)
timestamp_t approxidate_careful(const char *, int *);
timestamp_t approxidate_relative(const char *date);
-void parse_date_format(const char *format, struct date_mode *mode);
int date_overflows(timestamp_t date);
time_t tm_to_time_t(const struct tm *tm);
#endif
--
2.35.1.940.ge7a5b4b05f2
next prev parent reply other threads:[~2022-02-04 23:53 UTC|newest]
Thread overview: 125+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-09 14:38 UNLEAK(), leak checking in the default tests etc Ævar Arnfjörð Bjarmason
2021-06-09 17:44 ` Andrzej Hunt
2021-06-09 20:36 ` Felipe Contreras
2021-06-10 10:46 ` Jeff King
2021-06-10 10:56 ` Ævar Arnfjörð Bjarmason
2021-06-10 13:38 ` Jeff King
2021-06-10 15:32 ` Andrzej Hunt
2021-06-10 16:36 ` Jeff King
2021-06-11 15:44 ` Andrzej Hunt
2021-06-10 19:01 ` SZEDER Gábor
2021-07-14 0:11 ` [PATCH 0/4] add a test mode for SANITIZE=leak, run it in CI Ævar Arnfjörð Bjarmason
2021-07-14 0:11 ` [PATCH 1/4] tests: " Ævar Arnfjörð Bjarmason
2021-07-14 3:23 ` Đoàn Trần Công Danh
2021-07-14 0:11 ` [PATCH 2/4] SANITIZE tests: fix memory leaks in t13*config*, add to whitelist Ævar Arnfjörð Bjarmason
2021-07-14 0:11 ` [PATCH 3/4] SANITIZE tests: fix memory leaks in t5701*, " Ævar Arnfjörð Bjarmason
2021-07-14 0:11 ` [PATCH 4/4] SANITIZE tests: fix leak in mailmap.c Ævar Arnfjörð Bjarmason
2021-07-14 2:19 ` Eric Sunshine
2021-07-14 17:23 ` [PATCH v2 0/4] add a test mode for SANITIZE=leak, run it in CI Ævar Arnfjörð Bjarmason
2021-07-14 17:23 ` [PATCH v2 1/4] tests: " Ævar Arnfjörð Bjarmason
2021-07-14 18:42 ` Andrzej Hunt
2021-07-14 22:39 ` Ævar Arnfjörð Bjarmason
2021-07-15 21:14 ` Jeff King
2021-07-15 21:06 ` Jeff King
2021-07-16 14:46 ` Ævar Arnfjörð Bjarmason
2021-07-16 18:09 ` Jeff King
2021-07-16 18:45 ` Jeff King
2021-07-16 18:56 ` Ævar Arnfjörð Bjarmason
2021-07-16 19:22 ` Jeff King
2021-07-14 17:23 ` [PATCH v2 2/4] SANITIZE tests: fix memory leaks in t13*config*, add to whitelist Ævar Arnfjörð Bjarmason
2021-07-14 18:57 ` Andrzej Hunt
2021-07-14 22:56 ` Ævar Arnfjörð Bjarmason
2021-07-15 21:42 ` Jeff King
2021-07-16 5:18 ` Andrzej Hunt
2021-07-16 21:20 ` Jeff King
2021-07-16 7:46 ` Ævar Arnfjörð Bjarmason
2021-07-16 21:16 ` Jeff King
2021-08-31 12:47 ` Ævar Arnfjörð Bjarmason
2021-09-01 7:53 ` Jeff King
2021-09-01 11:45 ` Ævar Arnfjörð Bjarmason
2021-07-14 17:23 ` [PATCH v2 3/4] SANITIZE tests: fix memory leaks in t5701*, " Ævar Arnfjörð Bjarmason
2021-07-15 17:37 ` Andrzej Hunt
2021-07-15 21:43 ` Jeff King
2021-08-31 13:46 ` [PATCH] protocol-caps.c: fix memory leak in send_info() Ævar Arnfjörð Bjarmason
2021-08-31 15:32 ` Bruno Albuquerque
2021-08-31 18:15 ` Junio C Hamano
[not found] ` <CAPeR6H69a_HMwWnpHzssaCm_ow=ic7AnzMdZVQJQ2ECRDaWzaA@mail.gmail.com>
2021-08-31 20:08 ` Ævar Arnfjörð Bjarmason
2021-07-14 17:23 ` [PATCH v2 4/4] SANITIZE tests: fix leak in mailmap.c Ævar Arnfjörð Bjarmason
2021-08-31 13:42 ` [PATCH] mailmap.c: fix a memory leak in free_mailap_{info,entry}() Ævar Arnfjörð Bjarmason
2021-08-31 16:22 ` Eric Sunshine
2021-08-31 19:38 ` Jeff King
2021-08-31 19:46 ` Junio C Hamano
2021-07-15 17:37 ` [PATCH v2 0/4] add a test mode for SANITIZE=leak, run it in CI Andrzej Hunt
2021-08-31 13:35 ` [PATCH v3 0/8] " Ævar Arnfjörð Bjarmason
2021-09-01 9:56 ` Jeff King
2021-09-01 10:42 ` Jeff King
2021-09-02 12:25 ` Ævar Arnfjörð Bjarmason
2021-09-03 11:13 ` Jeff King
2021-09-07 15:33 ` [PATCH v4 0/3] " Ævar Arnfjörð Bjarmason
2021-09-07 15:33 ` [PATCH v4 1/3] Makefile: add SANITIZE=leak flag to GIT-BUILD-OPTIONS Ævar Arnfjörð Bjarmason
2021-09-07 15:33 ` [PATCH v4 2/3] CI: refactor "if" to "case" statement Ævar Arnfjörð Bjarmason
2021-09-07 15:33 ` [PATCH v4 3/3] tests: add a test mode for SANITIZE=leak, run it in CI Ævar Arnfjörð Bjarmason
2021-09-07 16:29 ` Eric Sunshine
2021-09-07 16:51 ` Jeff King
2021-09-07 16:44 ` [PATCH v4 0/3] " Jeff King
2021-09-07 18:22 ` Junio C Hamano
2021-09-07 21:30 ` [PATCH v5 " Ævar Arnfjörð Bjarmason
2021-09-07 21:30 ` [PATCH v5 1/3] Makefile: add SANITIZE=leak flag to GIT-BUILD-OPTIONS Ævar Arnfjörð Bjarmason
2021-09-07 21:30 ` [PATCH v5 2/3] CI: refactor "if" to "case" statement Ævar Arnfjörð Bjarmason
2021-09-07 21:30 ` [PATCH v5 3/3] tests: add a test mode for SANITIZE=leak, run it in CI Ævar Arnfjörð Bjarmason
2021-09-08 4:46 ` Eric Sunshine
2021-09-16 3:56 ` [PATCH] fixup! " Carlo Marcelo Arenas Belón
2021-09-16 6:14 ` Ævar Arnfjörð Bjarmason
2021-09-08 11:02 ` [PATCH v5 0/3] " Junio C Hamano
2021-09-08 12:03 ` Ævar Arnfjörð Bjarmason
2021-09-09 23:10 ` Emily Shaffer
2021-09-16 10:48 ` [PATCH v6 0/2] " Ævar Arnfjörð Bjarmason
2021-09-16 10:48 ` [PATCH v6 1/2] Makefile: add SANITIZE=leak flag to GIT-BUILD-OPTIONS Ævar Arnfjörð Bjarmason
2021-09-16 10:48 ` [PATCH v6 2/2] tests: add a test mode for SANITIZE=leak, run it in CI Ævar Arnfjörð Bjarmason
2021-09-19 8:03 ` [PATCH v7 0/2] " Ævar Arnfjörð Bjarmason
2021-09-19 8:03 ` [PATCH v7 1/2] Makefile: add SANITIZE=leak flag to GIT-BUILD-OPTIONS Ævar Arnfjörð Bjarmason
2021-09-19 8:03 ` [PATCH v7 2/2] tests: add a test mode for SANITIZE=leak, run it in CI Ævar Arnfjörð Bjarmason
2021-09-22 11:17 ` [PATCH] fixup! " Carlo Marcelo Arenas Belón
2021-09-23 1:50 ` Ævar Arnfjörð Bjarmason
2021-09-23 9:20 ` [PATCH v8 0/2] " Ævar Arnfjörð Bjarmason
2021-09-23 9:20 ` [PATCH v8 1/2] Makefile: add SANITIZE=leak flag to GIT-BUILD-OPTIONS Ævar Arnfjörð Bjarmason
2021-09-23 9:20 ` [PATCH v8 2/2] tests: add a test mode for SANITIZE=leak, run it in CI Ævar Arnfjörð Bjarmason
2021-11-03 22:44 ` Re* " Junio C Hamano
2021-11-03 23:57 ` Junio C Hamano
2021-11-04 10:06 ` Ævar Arnfjörð Bjarmason
2021-11-16 18:31 ` [PATCH] t0006: date_mode can leak .strftime_fmt member Ævar Arnfjörð Bjarmason
2021-11-16 19:04 ` Junio C Hamano
2021-11-16 19:31 ` Jeff King
2022-02-02 21:03 ` [PATCH 0/5] date.[ch] API: split from cache.h, add API docs, stop leaking memory Ævar Arnfjörð Bjarmason
2022-02-02 21:03 ` [PATCH 1/5] cache.h: remove always unused show_date_human() declaration Ævar Arnfjörð Bjarmason
2022-02-02 21:03 ` [PATCH 2/5] date API: create a date.h, split from cache.h Ævar Arnfjörð Bjarmason
2022-02-02 21:19 ` Ævar Arnfjörð Bjarmason
2022-02-15 3:04 ` Junio C Hamano
2022-02-02 21:03 ` [PATCH 3/5] date API: provide and use a DATE_MODE_INIT Ævar Arnfjörð Bjarmason
2022-02-02 21:03 ` [PATCH 4/5] date API: add basic API docs Ævar Arnfjörð Bjarmason
2022-02-15 2:14 ` Junio C Hamano
2022-02-02 21:03 ` [PATCH 5/5] date API: add and use a date_mode_release() Ævar Arnfjörð Bjarmason
2022-02-15 0:28 ` Junio C Hamano
2022-02-04 23:53 ` [PATCH v2 0/5] date.[ch] API: split from cache.h, add API docs, stop leaking memory Ævar Arnfjörð Bjarmason
2022-02-04 23:53 ` [PATCH v2 1/5] cache.h: remove always unused show_date_human() declaration Ævar Arnfjörð Bjarmason
2022-02-04 23:53 ` [PATCH v2 2/5] date API: create a date.h, split from cache.h Ævar Arnfjörð Bjarmason
2022-02-04 23:53 ` [PATCH v2 3/5] date API: provide and use a DATE_MODE_INIT Ævar Arnfjörð Bjarmason
2022-02-04 23:53 ` Ævar Arnfjörð Bjarmason [this message]
2022-02-04 23:53 ` [PATCH v2 5/5] date API: add and use a date_mode_release() Ævar Arnfjörð Bjarmason
2022-02-14 17:25 ` [PATCH v2 0/5] date.[ch] API: split from cache.h, add API docs, stop leaking memory Ævar Arnfjörð Bjarmason
2022-02-14 19:52 ` Junio C Hamano
2022-02-16 8:14 ` [PATCH v3 " Ævar Arnfjörð Bjarmason
2022-02-16 8:14 ` [PATCH v3 1/5] cache.h: remove always unused show_date_human() declaration Ævar Arnfjörð Bjarmason
2022-02-16 8:14 ` [PATCH v3 2/5] date API: create a date.h, split from cache.h Ævar Arnfjörð Bjarmason
2022-02-16 8:14 ` [PATCH v3 3/5] date API: provide and use a DATE_MODE_INIT Ævar Arnfjörð Bjarmason
2022-02-16 8:14 ` [PATCH v3 4/5] date API: add basic API docs Ævar Arnfjörð Bjarmason
2022-02-16 8:14 ` [PATCH v3 5/5] date API: add and use a date_mode_release() Ævar Arnfjörð Bjarmason
2022-02-16 17:45 ` [PATCH v3 0/5] date.[ch] API: split from cache.h, add API docs, stop leaking memory Junio C Hamano
[not found] ` <cover-v3-0.8-00000000000-20210831T132607Z-avarab@gmail.com>
2021-08-31 13:35 ` [PATCH v3 1/8] Makefile: add SANITIZE=leak flag to GIT-BUILD-OPTIONS Ævar Arnfjörð Bjarmason
2021-08-31 13:35 ` [PATCH v3 2/8] CI: refactor "if" to "case" statement Ævar Arnfjörð Bjarmason
2021-08-31 13:35 ` [PATCH v3 3/8] tests: add a test mode for SANITIZE=leak, run it in CI Ævar Arnfjörð Bjarmason
2021-08-31 13:35 ` [PATCH v3 4/8] tests: annotate t000*.sh with TEST_PASSES_SANITIZE_LEAK=true Ævar Arnfjörð Bjarmason
2021-08-31 13:35 ` [PATCH v3 5/8] tests: annotate t001*.sh " Ævar Arnfjörð Bjarmason
2021-08-31 13:35 ` [PATCH v3 6/8] tests: annotate t002*.sh " Ævar Arnfjörð Bjarmason
2021-08-31 13:35 ` [PATCH v3 7/8] tests: annotate select t0*.sh " Ævar Arnfjörð Bjarmason
2021-08-31 13:35 ` [PATCH v3 8/8] tests: annotate select t*.sh " Ævar Arnfjörð Bjarmason
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=patch-v2-4.5-3f70b1aa4c5-20220204T235143Z-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
/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).