[glib] Improve g_file_set_contents docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Improve g_file_set_contents docs
- Date: Thu, 26 Aug 2010 04:02:57 +0000 (UTC)
commit b52cdaf2f01411df86b418f45a7dc04f1499fabe
Author: Matthias Clasen <mclasen redhat com>
Date: Thu Aug 26 00:00:56 2010 -0400
Improve g_file_set_contents docs
Mention that the temporary filename is longer than the passed-in
filename, so people can avoid passing a name that is already
NAME_MAX long.
glib/gfileutils.c | 3 +++
1 files changed, 3 insertions(+), 0 deletions(-)
---
diff --git a/glib/gfileutils.c b/glib/gfileutils.c
index bfd6bb6..820ed95 100644
--- a/glib/gfileutils.c
+++ b/glib/gfileutils.c
@@ -1056,6 +1056,9 @@ write_to_temp_file (const gchar *contents,
* it returns %FALSE and sets @error. The error domain is #G_FILE_ERROR.
* Possible error codes are those in the #GFileError enumeration.
*
+ * Note that the name for the temporary file is constructed by appending up
+ * to 7 characters to @filename.
+ *
* Return value: %TRUE on success, %FALSE if an error occurred
*
* Since: 2.8
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]