From 69ddf1d6c778e317ed6b9f7c92a44d421f869645 Mon Sep 17 00:00:00 2001
From: "Ryan C. Gordon" <[EMAIL REDACTED]>
Date: Fri, 20 Feb 2026 14:29:46 -0500
Subject: [PATCH] docs: Clarify symlink info in SDL_GetPathInfo, etc.
Fixes #15078.
---
include/SDL3/SDL_filesystem.h | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/include/SDL3/SDL_filesystem.h b/include/SDL3/SDL_filesystem.h
index ef0bd4266be28..0062935541810 100644
--- a/include/SDL3/SDL_filesystem.h
+++ b/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.