Просмотр исходного кода

docs: Clarify symlink info in SDL_GetPathInfo, etc.

Fixes #15078.

(cherry picked from commit 69ddf1d6c778e317ed6b9f7c92a44d421f869645)
Ryan C. Gordon 1 неделя назад
Родитель
Сommit
70e1804e9f
1 измененных файлов с 5 добавлено и 2 удалено
  1. 5 2
      include/SDL3/SDL_filesystem.h

+ 5 - 2
include/SDL3/SDL_filesystem.h

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