Changeset 39825 in vbox

Timestamp:

Jan 20, 2012 9:47:56 PM (13 years ago)

Author:

vboxsync

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

75828

Message:

VBoxGuestInfo2::szName updated documenation.

File:

• trunk/include/VBox/VMMDev.h (modified) (1 diff)

trunk/include/VBox/VMMDev.h

@@ -673 +673 @@
     /** Feature mask, currently unused. */
     uint32_t additionsFeatures;
-    /** Some additional information, for example 'Beta 1' or something like that. */
+    /** The intentional meaning of this field was:
+     * Some additional information, for example 'Beta 1' or something like that.
+     *
+     * The way it was implemented was implemented: VBOX_VERSION_STRING.
+     *
+     * This means the first three members are duplicated in this field (if the guest
+     * build config is sane). So, the user must check this and chop it off before
+     * usage.  There is, because of the Main code's blind trust in the field's
+     * content, no way back. */
     char     szName[128];
 } VBoxGuestInfo2;