luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-11-04 10:08:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Discourage use of gstdio.h and clarify its header requirements

Browse Source 
Signed-off-by: Philip Withnall <withnall@endlessm.com>

https://bugzilla.gnome.org/show_bug.cgi?id=781598
This commit is contained in:
Philip Withnall
2017-09-12 12:20:18 +01:00
parent 39469aa7bb
commit 1a5cebec39
2 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/glib/glib-sections.txt
View File

@@ -1324,7 +1324,7 @@ g_option_error_quark
<SECTION> <SECTION>
<TITLE>File Utilities</TITLE> <TITLE>File Utilities</TITLE>
<FILE>fileutils</FILE> <FILE>fileutils</FILE>
<INCLUDE>glib.h,glib/gstdio.h</INCLUDE> <INCLUDE>glib.h,glib/gstdio.h,fcntl.h,sys/types.h,sys/stat.h</INCLUDE>
GFileError GFileError
G_FILE_ERROR G_FILE_ERROR
GFileTest GFileTest

9
glib/gfileutils.c
View File

@@ -62,6 +62,10 @@
* @title: File Utilities * @title: File Utilities
* @short_description: various file-related functions * @short_description: various file-related functions
* *
* Do not use these APIs unless you are porting a POSIX application to Windows.
* A more high-level file access API is provided as GIO — see the documentation
* for #GFile.
*
* There is a group of functions which wrap the common POSIX functions * There is a group of functions which wrap the common POSIX functions
* dealing with filenames (g_open(), g_rename(), g_mkdir(), g_stat(), * dealing with filenames (g_open(), g_rename(), g_mkdir(), g_stat(),
* g_unlink(), g_remove(), g_fopen(), g_freopen()). The point of these * g_unlink(), g_remove(), g_fopen(), g_freopen()). The point of these
@@ -69,6 +73,11 @@
* characters in them on Windows without having to use ifdefs and the * characters in them on Windows without having to use ifdefs and the
* wide character API in the application code. * wide character API in the application code.
* *
* On some Unix systems, these APIs may be defined as identical to their POSIX
* counterparts. For this reason, you must check for and include the necessary
* header files (such as `fcntl.h`) before using functions like g_creat(). You
* must also define the relevant feature test macros.
*
* The pathname argument should be in the GLib file name encoding. * The pathname argument should be in the GLib file name encoding.
* On POSIX this is the actual on-disk encoding which might correspond * On POSIX this is the actual on-disk encoding which might correspond
* to the locale settings of the process (or the `G_FILENAME_ENCODING` * to the locale settings of the process (or the `G_FILENAME_ENCODING`