diff options
author | Kai Köhne <kai.koehne@qt.io> | 2022-12-20 13:43:41 +0100 |
---|---|---|
committer | Kai Köhne <kai.koehne@qt.io> | 2022-12-23 08:28:23 +0100 |
commit | 9f3395b4d30c7d12af83b036c6e02a51668e9d60 (patch) | |
tree | b5e16181eb8833145e2da364a8b0e4b18b615ca1 /src/corelib/io | |
parent | b82c9d08f835c3a0babe7c8adb495836a57d682c (diff) |
QFileInfo: Restructure overview
Use less \notes, more sections.
Change-Id: I4c94d67a66c906e0d3b6f55127fce85e974b9138
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'src/corelib/io')
-rw-r--r-- | src/corelib/io/qfileinfo.cpp | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/src/corelib/io/qfileinfo.cpp b/src/corelib/io/qfileinfo.cpp index 9542a0c74b..22127d86a2 100644 --- a/src/corelib/io/qfileinfo.cpp +++ b/src/corelib/io/qfileinfo.cpp @@ -226,21 +226,6 @@ QDateTime &QFileInfoPrivate::getFileTime(QAbstractFileEngine::FileTime request) isSymLink(). The symLinkTarget() function provides the name of the file the symlink points to. - On Unix (including \macos and iOS), the property getter functions in this - class return the properties such as times and size of the target file, not - the symlink, because Unix handles symlinks transparently. Opening a symlink - using QFile effectively opens the link's target. For example: - - \snippet code/src_corelib_io_qfileinfo.cpp 0 - - On Windows, shortcuts (\c .lnk files) are currently treated as symlinks. As - on Unix systems, the property getters return the size of the targeted file, - not the \c .lnk file itself. This behavior is deprecated and will likely be - removed in a future version of Qt, after which \c .lnk files will be treated - as regular files. - - \snippet code/src_corelib_io_qfileinfo.cpp 1 - Elements of the file's name can be extracted with path() and fileName(). The fileName()'s parts can be extracted with baseName(), suffix() or completeSuffix(). QFileInfo objects to @@ -258,8 +243,26 @@ QDateTime &QFileInfoPrivate::getFileTime(QAbstractFileEngine::FileTime request) permissions and ownership in a single statement using the permission() function. - \target NTFS permissions - \note On NTFS file systems, ownership and permissions checking is + \section1 Symbolic Links and Shortcuts + + On Unix (including \macos and iOS), the property getter functions in this + class return the properties such as times and size of the target file, not + the symlink, because Unix handles symlinks transparently. Opening a symlink + using QFile effectively opens the link's target. For example: + + \snippet code/src_corelib_io_qfileinfo.cpp 0 + + On Windows, shortcuts (\c .lnk files) are currently treated as symlinks. As + on Unix systems, the property getters return the size of the targeted file, + not the \c .lnk file itself. This behavior is deprecated and will likely be + removed in a future version of Qt, after which \c .lnk files will be treated + as regular files. + + \snippet code/src_corelib_io_qfileinfo.cpp 1 + + \section1 NTFS permissions + + On NTFS file systems, ownership and permissions checking is disabled by default for performance reasons. To enable it, include the following line: @@ -270,7 +273,7 @@ QDateTime &QFileInfoPrivate::getFileTime(QAbstractFileEngine::FileTime request) \snippet ntfsp.cpp 1 - \section1 Performance Issues + \section1 Performance Considerations Some of QFileInfo's functions query the file system, but for performance reasons, some functions only operate on the @@ -279,10 +282,8 @@ QDateTime &QFileInfoPrivate::getFileTime(QAbstractFileEngine::FileTime request) The path() function, however, can work on the file name directly, and so it is faster. - \note To speed up performance, QFileInfo caches information about - the file. - - Because files can be changed by other users or programs, or + To speed up performance, QFileInfo also caches information about + the file. Because files can be changed by other users or programs, or even by other parts of the same program, there is a function that refreshes the file information: refresh(). If you want to switch off a QFileInfo's caching and force it to access the file system |