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.
This commit is contained in:
Matthias Clasen 2010-08-26 00:00:56 -04:00
parent 925b4231dc
commit b52cdaf2f0

View File

@ -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