Changeset 39641 in vbox

Timestamp:

Dec 16, 2011 8:14:53 AM (13 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

75438

Message:

IPRT headers: warning

Location:

trunk/include/iprt

Files:

• dir.h (modified) (2 diffs)
• file.h (modified) (2 diffs)
• path.h (modified) (3 diffs)
• symlink.h (modified) (4 diffs)

trunk/include/iprt/dir.h

@@ -53 +53 @@
 /** @name RTDirCreate  flags.
  * @{ */
-/** Don't allow symbolic links as part of the path. */
+/** Don't allow symbolic links as part of the path.
+ * @remarks this flag is currently not implemented and will be ignored. */
 #define RTDIRCREATE_FLAGS_NO_SYMLINKS  RT_BIT(0)
 /** @} */
@@ -304 +305 @@
 /** @name RTDirOpenFiltered  flags.
  * @{ */
-/** Don't allow symbolic links as part of the path. */
+/** Don't allow symbolic links as part of the path.
+ * @remarks this flag is currently not implemented and will be ignored. */
 #define RTDIROPEN_FLAGS_NO_SYMLINKS  RT_BIT(0)
 /** @} */

trunk/include/iprt/file.h

@@ -213 +213 @@
 #define RTFILE_O_NO_CACHE               UINT32_C(0x00080000)
 
-/** Don't allow symbolic links as part of the path. */
+/** Don't allow symbolic links as part of the path.
+ * @remarks this flag is currently not implemented and will be ignored. */
 #define RTFILE_O_NO_SYMLINKS            UINT32_C(0x20000000)
 
@@ -565 +566 @@
 /** Replace destination file if present. */
 #define RTFILEMOVE_FLAGS_REPLACE      0x1
-/** Don't allow symbolic links as part of the path. */
+/** Don't allow symbolic links as part of the path.
+ * @remarks this flag is currently not implemented and will be ignored. */
 #define RTFILEMOVE_FLAGS_NO_SYMLINKS  0x2
 /** @} */

trunk/include/iprt/path.h

@@ -127 +127 @@
 /** Last component: Follow if link. */
 #define RTPATH_F_FOLLOW_LINK      RT_BIT_32(1)
-/** Don't allow symbolic links as part of the path. */
+/** Don't allow symbolic links as part of the path.
+ * @remarks this flag is currently not implemented and will be ignored. */
 #define RTPATH_F_NO_SYMLINKS      RT_BIT_32(2)
 /** @} */
@@ -894 +895 @@
 /** This will replace attempt any target which isn't a directory. */
 #define RTPATHRENAME_FLAGS_REPLACE      RT_BIT(0)
-/** Don't allow symbolic links as part of the path. */
+/** Don't allow symbolic links as part of the path.
+ * @remarks this flag is currently not implemented and will be ignored. */
 #define RTPATHRENAME_FLAGS_NO_SYMLINKS  RT_BIT(1)
 /** @} */
@@ -913 +915 @@
 /** @name RTPathUnlink flags.
  * @{ */
-/** Don't allow symbolic links as part of the path. */
+/** Don't allow symbolic links as part of the path.
+ * @remarks this flag is currently not implemented and will be ignored. */
 #define RTPATHUNLINK_FLAGS_NO_SYMLINKS  RT_BIT(0)
 /** @} */

trunk/include/iprt/symlink.h

@@ -88 +88 @@
 /** @name RTSymlinkCreate flags.
  * @{ */
-/** Don't allow symbolic links as part of the path. */
+/** Don't allow symbolic links as part of the path.
+ * @remarks this flag is currently not implemented and will be ignored. */
 #define RTSYMLINKCREATE_FLAGS_NO_SYMLINKS  RT_BIT(0)
 /** @} */
@@ -99 +100 @@
  * @param   pszSymlink      The name of the symbolic link.
  * @param   pszTarget       The path to the symbolic link target.  This is
- *                          relative to @a pszSymlink.
+ *                          relative to @a pszSymlink or an absolute path.
  * @param   enmType         The symbolic link type.  For Windows compatability
  *                          it is very important to set this correctly.  When
@@ -112 +113 @@
 /** @name RTSymlinkDelete flags.
  * @{ */
-/** Don't allow symbolic links as part of the path. */
+/** Don't allow symbolic links as part of the path.
+ * @remarks this flag is currently not implemented and will be ignored. */
 #define RTSYMLINKDELETE_FLAGS_NO_SYMLINKS  RT_BIT(0)
 /** @} */
@@ -132 +134 @@
 /** @name RTSymlinkRead  flags.
  * @{ */
-/** Don't allow symbolic links as part of the path. */
+/** Don't allow symbolic links as part of the path.
+ * @remarks this flag is currently not implemented and will be ignored. */
 #define RTSYMLINKREAD_FLAGS_NO_SYMLINKS  RT_BIT(0)
 /** @} */