]> git.ipfire.org Git - thirdparty/git.git/commitdiff
strbuf.h comment: discuss strbuf_addftime() arguments in order
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Sat, 24 Jun 2017 12:14:51 +0000 (12:14 +0000)
committerJunio C Hamano <gitster@pobox.com>
Sat, 24 Jun 2017 18:15:59 +0000 (11:15 -0700)
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>
strbuf.h

index 4559035c47268c0603119b90c7278c08c6b99a09..6708cef0f9adeae434ce95eb17cdf0b428045d29 100644 (file)
--- a/strbuf.h
+++ b/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,