1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

QDir: improve mkdir/mkpath API docs

Browse Source 
Pick-to: 6.8 6.5
Task-number: QTBUG-132633
Change-Id: Iafe4a20bacbbf55d19377e8cd04f940d4f2a66f6
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
(cherry picked from commit 23981aae0e059d876d441bfffae9d9d0fd671bde)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Ahmad Samir 2025-01-21 14:35:26 +02:00 committed by Qt Cherry-pick Bot
parent d2f48abeb5
commit d47af17a0d
1 changed files with 38 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
src/corelib/io/qdir.cpp
View File

@ -1493,22 +1493,26 @@ QFileInfoList QDir::entryInfoList(const QStringList &nameFilters, Filters filter
#endif // !QT_BOOTSTRAPPED #endif // !QT_BOOTSTRAPPED
/*! /*!
Creates a sub-directory called \a dirName. Creates a sub-directory called \a dirName with the given \a permissions.
Returns \c true on success; otherwise returns \c false. Returns \c true on success; returns \c false if the operation failed or
the directory already existed.
If the directory already exists when this function is called, it will return \c false. //! [dir-creation-mode-bits-unix]
On POSIX systems \a permissions are modified by the
\l{https://pubs.opengroup.org/onlinepubs/9799919799/functions/umask.html}{\c umask}
(file creation mask) of the current process, which means some permission
bits might be disabled.
//! [dir-creation-mode-bits-unix]
The permissions of the created directory are set to \a{permissions}. On Windows, by default, a new directory inherits its permissions from its
parent directory. \a permissions are emulated using ACLs. These ACLs may
be in non-canonical order when the group is granted less permissions than
others. Files and directories with such permissions will generate warnings
when the Security tab of the Properties dialog is opened. Granting the
group all permissions granted to others avoids such warnings.
On POSIX systems the permissions are influenced by the value of \c umask. \sa rmdir(), mkpath(), rmpath()
On Windows the permissions are emulated using ACLs. These ACLs may be in non-canonical
order when the group is granted less permissions than others. Files and directories with
such permissions will generate warnings when the Security tab of the Properties dialog
is opened. Granting the group all permissions granted to others avoids such warnings.
\sa rmdir()
\since 6.3 \since 6.3
*/ */
@ -1529,10 +1533,22 @@ bool QDir::mkdir(const QString &dirName, QFile::Permissions permissions) const
/*! /*!
\overload \overload
Creates a sub-directory called \a dirName with default permissions. Creates a sub-directory called \a dirName with the platform-specific
default permissions.
On POSIX systems the default is to grant all permissions allowed by \c umask. Returns \c true on success; returns \c false if the operation failed or
On Windows, the new directory inherits its permissions from its parent directory. the directory already existed.
//! [windows-permissions-acls]
On Windows, by default, a new directory inherits its permissions from its
parent directory. Permissions are emulated using ACLs. These ACLs may be
in non-canonical order when the group is granted less permissions than
others. Files and directories with such permissions will generate warnings
when the Security tab of the Properties dialog is opened. Granting the
group all permissions granted to others avoids such warnings.
//! [windows-permissions-acls]
\sa rmdir(), mkpath(), rmpath()
*/ */
bool QDir::mkdir(const QString &dirName) const bool QDir::mkdir(const QString &dirName) const
{ {
@ -1575,16 +1591,17 @@ bool QDir::rmdir(const QString &dirName) const
} }
/*! /*!
Creates the directory path \a dirPath. Creates a directory named \a dirPath.
The function will create all parent directories necessary to If \a dirPath doesn't already exist, this method will create it - along with
create the directory. any nonexistent parent directories - with the default permissions.
Returns \c true if successful; otherwise returns \c false. Returns \c true on success or if \a dirPath already existed; otherwise
returns \c false.
If the path already exists when this function is called, it will return true. \include qdir.cpp windows-permissions-acls
\sa rmpath() \sa rmpath(), mkdir(), rmdir()
*/ */
bool QDir::mkpath(const QString &dirPath) const bool QDir::mkpath(const QString &dirPath) const
{ {