summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEtienne Samson <samson.etienne@gmail.com>2019-01-15 11:32:13 +0100
committerEtienne Samson <samson.etienne@gmail.com>2019-01-28 13:05:15 +0100
commit9e4d421edd42b785d52a8cefbda8b77f6a8e65f3 (patch)
treec377c7fe4cce97654001b084149195631e024f7c
parente9a34864784db3eeb6613ca80f33bed3371d65d5 (diff)
downloadlibgit2-9e4d421edd42b785d52a8cefbda8b77f6a8e65f3.tar.gz
doc: clarify that git_time_t is seconds from the epoch
-rw-r--r--include/git2/signature.h4
-rw-r--r--include/git2/types.h2
2 files changed, 3 insertions, 3 deletions
diff --git a/include/git2/signature.h b/include/git2/signature.h
index 7a2a0238a..b14f3ea89 100644
--- a/include/git2/signature.h
+++ b/include/git2/signature.h
@@ -30,8 +30,8 @@ GIT_BEGIN_DECL
* @param out new signature, in case of error NULL
* @param name name of the person
* @param email email of the person
- * @param time time when the action happened
- * @param offset timezone offset in minutes for the time
+ * @param time time (in seconds from epoch) when the action happened
+ * @param offset timezone offset (in minutes) for the time
* @return 0 or an error code
*/
GIT_EXTERN(int) git_signature_new(git_signature **out, const char *name, const char *email, git_time_t time, int offset);
diff --git a/include/git2/types.h b/include/git2/types.h
index 6c57ed0af..0eaa0041d 100644
--- a/include/git2/types.h
+++ b/include/git2/types.h
@@ -59,7 +59,7 @@ typedef __haiku_std_int64 git_time_t;
* app, even though /we/ define _FILE_OFFSET_BITS=64.
*/
typedef int64_t git_off_t;
-typedef int64_t git_time_t;
+typedef int64_t git_time_t; /**< time in seconds from epoch */
#endif