mirror of
https://github.com/git/git
synced 2024-08-26 19:19:18 +00:00
strbuf.h comment: discuss strbuf_addftime() arguments in order
Change the comment documenting the strbuf_addftime() function to discuss the parameters in the order in which they appear, which makes this easier to read than discussing them out of order. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
6eced3ec5e
commit
4904cbc9e1
2
strbuf.h
2
strbuf.h
|
@ -340,10 +340,10 @@ extern void strbuf_vaddf(struct strbuf *sb, const char *fmt, va_list ap);
|
|||
|
||||
/**
|
||||
* Add the time specified by `tm`, as formatted by `strftime`.
|
||||
* `tz_name` is used to expand %Z internally unless it's NULL.
|
||||
* `tz_offset` is in decimal hhmm format, e.g. -600 means six hours west
|
||||
* of Greenwich, and it's used to expand %z internally. However, tokens
|
||||
* with modifiers (e.g. %Ez) are passed to `strftime`.
|
||||
* `tz_name` is used to expand %Z internally unless it's NULL.
|
||||
*/
|
||||
extern void strbuf_addftime(struct strbuf *sb, const char *fmt,
|
||||
const struct tm *tm, int tz_offset,
|
||||
|
|
Loading…
Reference in a new issue