Changeset 97409 in vbox

Timestamp:

Nov 5, 2022 11:19:12 PM (2 years ago)

Author:

vboxsync

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

154414

Message:

Main/GuestCtrlPrivate.cpp: Don't use doxygen-style comments inside function for non-doxygen commenting (doxgyen got confused by non-html tags). Added @todo about confusing code in GuestPath::Translate wrt 'escape sequnces' in paths. bugref:10286

File:

• trunk/src/VBox/Main/src-client/GuestCtrlPrivate.cpp (modified) (3 diffs)

trunk/src/VBox/Main/src-client/GuestCtrlPrivate.cpp

@@ -1723 +1723 @@
  */
 /* static */
-int GuestPath::BuildDestinationPath(const Utf8Str &strSrcPath, PathStyle_T enmSrcPathStyle, Utf8Str &strDstPath, PathStyle_T enmDstPathStyle)
-{
-    /**
+int GuestPath::BuildDestinationPath(const Utf8Str &strSrcPath, PathStyle_T enmSrcPathStyle,
+                                    Utf8Str &strDstPath, PathStyle_T enmDstPathStyle)
+{
+    /*
      * Rules:
      *
@@ -1735 +1736 @@
      */
     const char *pszSrcName = RTPathFilenameEx(strSrcPath.c_str(),
-                                                 enmSrcPathStyle == PathStyle_DOS
+                                                enmSrcPathStyle == PathStyle_DOS
                                               ? RTPATH_STR_F_STYLE_DOS : RTPATH_STR_F_STYLE_UNIX);
 
@@ -1811 +1812 @@
                  * however, on DOS "\" is a path separator.
                  *
-                 * See @bugref{21095}.
+                 * See @ticketref{21095}.
+                 */
+                /** @todo r=bird: Seeing that callers like GuestSessionTaskCopyFrom::Run() has
+                 * passed strPath to RTPathQueryInfoEx() prior to calling this function, I don't
+                 * get the comments a bout escape sequence stuff here.
+                 *
+                 * "\" ("\\" in C/C++) is not an escape sequence on unix unless you're in a
+                 * typical unix shell like bash.  It's just a filename character that doesn't
+                 * get interpreted as anything special by the kernel (unlike '/' and '\0' (C/C++
+                 * encoding)).
+                 *
+                 * "\ " (or "\\ " in C/C++) does not mark a single space in a path component, it
+                 * signifies two characters, a backslash and a space, neither with any special
+                 * meaning to a UNIX host.
                  */
                 else if (psz[off] == '\\')