BramReuling/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-06-06 06:34:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: Clarify symlink info in SDL_GetPathInfo, etc.

Browse source 
Fixes #15078.

(cherry picked from commit 69ddf1d6c7)
This commit is contained in:
Ryan C. Gordon 2026-02-20 14:29:46 -05:00
parent eaa20b5e8a
commit 70e1804e9f
No known key found for this signature in database
GPG key ID: FA148B892AB48044
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
include/SDL3/SDL_filesystem.h
View file

@ -242,8 +242,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetUserFolder(SDL_Folder folder);
* Types of filesystem entries.
*
* Note that there may be other sorts of items on a filesystem: devices,
* symlinks, named pipes, etc. They are currently reported as
* SDL_PATHTYPE_OTHER.
* named pipes, etc. They are currently reported as SDL_PATHTYPE_OTHER.
*
* \since This enum is available since SDL 3.2.0.
*
@ -457,6 +456,10 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CopyFile(const char *oldpath, const char *n
/**
* Get information about a filesystem path.
*
* Symlinks, on filesystems that support them, are always followed, so you will
* always get information on what the symlink eventually points to, and not the
* symlink itself.
*
* \param path the path to query.
* \param info a pointer filled in with information about the path, or NULL to
* check for the existence of a file.