diff options
author | Christian Grothoff <christian@grothoff.org> | 2013-10-08 06:47:12 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2013-10-08 06:47:12 +0000 |
commit | 06f3ffeab2cf652874a0539eaafa34762fe360b3 (patch) | |
tree | f0de78f14275b873db6d7a378dfe6744465a37a4 /src/include/gnunet_strings_lib.h | |
parent | 845f6dac09a9a4807c4734b09d8d2632903b0383 (diff) | |
download | gnunet-06f3ffeab2cf652874a0539eaafa34762fe360b3.tar.gz gnunet-06f3ffeab2cf652874a0539eaafa34762fe360b3.zip |
-document UTC vs local time
Diffstat (limited to 'src/include/gnunet_strings_lib.h')
-rw-r--r-- | src/include/gnunet_strings_lib.h | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/src/include/gnunet_strings_lib.h b/src/include/gnunet_strings_lib.h index cf56b2cce..6fbdb6e8e 100644 --- a/src/include/gnunet_strings_lib.h +++ b/src/include/gnunet_strings_lib.h | |||
@@ -77,11 +77,12 @@ GNUNET_STRINGS_fancy_time_to_relative (const char *fancy_time, | |||
77 | 77 | ||
78 | /** | 78 | /** |
79 | * Convert a given fancy human-readable time to our internal | 79 | * Convert a given fancy human-readable time to our internal |
80 | * representation. | 80 | * representation. The human-readable time is expected to be |
81 | * in local time, whereas the returned value will be in UTC. | ||
81 | * | 82 | * |
82 | * @param fancy_time human readable string (i.e. %Y-%m-%d %H:%M:%S) | 83 | * @param fancy_time human readable string (i.e. %Y-%m-%d %H:%M:%S) |
83 | * @param atime set to the absolute time | 84 | * @param atime set to the absolute time |
84 | * @return GNUNET_OK on success, GNUNET_SYSERR on error | 85 | * @return #GNUNET_OK on success, #GNUNET_SYSERR on error |
85 | */ | 86 | */ |
86 | int | 87 | int |
87 | GNUNET_STRINGS_fancy_time_to_absolute (const char *fancy_time, | 88 | GNUNET_STRINGS_fancy_time_to_absolute (const char *fancy_time, |
@@ -223,12 +224,13 @@ GNUNET_STRINGS_buffer_tokenize (const char *buffer, size_t size, | |||
223 | 224 | ||
224 | 225 | ||
225 | /** | 226 | /** |
226 | * "asctime", except for GNUnet time. | 227 | * "asctime", except for GNUnet time. Converts a GNUnet internal |
228 | * absolute time (which is in UTC) to a string in local time. | ||
227 | * This is one of the very few calls in the entire API that is | 229 | * This is one of the very few calls in the entire API that is |
228 | * NOT reentrant! | 230 | * NOT reentrant! |
229 | * | 231 | * |
230 | * @param t the absolute time to convert | 232 | * @param t the absolute time to convert |
231 | * @return timestamp in human-readable form | 233 | * @return timestamp in human-readable form in local time |
232 | */ | 234 | */ |
233 | const char * | 235 | const char * |
234 | GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t); | 236 | GNUNET_STRINGS_absolute_time_to_string (struct GNUNET_TIME_Absolute t); |