Changeset 70891 in vbox for trunk/include/iprt

Timestamp:

Feb 7, 2018 2:07:57 PM (7 years ago)

Author:

vboxsync

Message:

iprt/path.h: RTPathAbs doc update.

File:

• trunk/include/iprt/path.h (modified) (5 diffs)

trunk/include/iprt/path.h

@@ -294 +294 @@
 /**
  * Get the absolute path (starts from root, no . or .. components), doesn't have
- * to exist. Note that this method is designed to never perform actual file
- * system access, therefore symlinks are not resolved.
+ * to exist.
+ *
+ * Note that this method is designed to never perform actual file system access,
+ * therefore symlinks are not resolved.
  *
  * @returns iprt status code.
@@ -301 +303 @@
  * @param   pszAbsPath      Where to store the absolute path.
  * @param   cchAbsPath      Size of the buffer.
+ *
+ * @note    Current implementation is buggy and will remove trailing slashes
+ *          that would normally specify a directory.  Don't depend on this.
  */
 RTDECL(int) RTPathAbs(const char *pszPath, char *pszAbsPath, size_t cchAbsPath);
@@ -310 +315 @@
  * @returns NULL if RTPathAbs() or RTStrDup() fails.
  * @param   pszPath         The path to resolve.
+ *
+ * @note    Current implementation is buggy and will remove trailing slashes
+ *          that would normally specify a directory.  Don't depend on this.
  */
 RTDECL(char *) RTPathAbsDup(const char *pszPath);
@@ -325 +333 @@
  * @param   pszAbsPath      Where to store the absolute path.
  * @param   cchAbsPath      Size of the buffer.
+ *
+ * @note    Current implementation is buggy and will remove trailing slashes
+ *          that would normally specify a directory.  Don't depend on this.
  */
 RTDECL(int) RTPathAbsEx(const char *pszBase, const char *pszPath, char *pszAbsPath, size_t cchAbsPath);
@@ -337 +348 @@
  *                          is equivalent to RTPathAbs(pszPath, ...).
  * @param   pszPath         The path to resolve.
+ *
+ * @note    Current implementation is buggy and will remove trailing slashes
+ *          that would normally specify a directory.  Don't depend on this.
  */
 RTDECL(char *) RTPathAbsExDup(const char *pszBase, const char *pszPath);