Changeset 94202 in vbox for trunk

Timestamp:

Mar 12, 2022 7:35:12 PM (3 years ago)

Author:

vboxsync

Message:

doc/manual,FE/VBoxManage: Convert checkmediumpwd command to refentry documentation, ​bugref:9186

Location:

trunk

Files:

• doc/manual/Config.kmk (modified) (1 diff)
• doc/manual/en_US/man_VBoxManage-checkmediumpwd.xml (modified) (4 diffs)
• doc/manual/en_US/user_VBoxManage.xml (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManage.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManage.h (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageDisk.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (1 diff)

trunk/doc/manual/Config.kmk

@@ -71 +71 @@
         man_VBoxManage-clonemedium.xml \
         man_VBoxManage-mediumproperty.xml \
-        man_VBoxManage-encryptmedium.xml
+        man_VBoxManage-encryptmedium.xml \
+        man_VBoxManage-checkmediumpwd.xml
 
 ## List of user manual XML files.

trunk/doc/manual/en_US/man_VBoxManage-checkmediumpwd.xml

@@ -20 +20 @@
 <refentry id="vboxmanage-checkmediumpwd" lang="en">
   <refentryinfo>
-    <pubdate>August 2019</pubdate>
+    <pubdate>$Date$</pubdate>
     <title>VBoxManage checkmediumpwd</title>
   </refentryinfo>
@@ -32 +32 @@
     <refname>VBoxManage-checkmediumpwd</refname>
     <refpurpose>check encryption password on a DEK-encrypted medium or a disk image</refpurpose>
-    <refclass>Oracle VM VirtualBox</refclass>
+    <refclass>&product-name;</refclass>
   </refnamediv>
 
@@ -69 +69 @@
         <term><replaceable>password-file</replaceable></term>
         <listitem><para>
-            Specifies the password identifier to check. The password
-            identifier can be the absolute path name of a password file
+            Specifies the password to check. The password
+            can be the absolute path name of a password file
             on the host OS or the dash character (<literal>-</literal>)
             to prompt you for the password on the command line.
@@ -84 +84 @@
       The following example checks the encryption password for the
       <filename>ol7u4-1.vdi</filename> disk image. The password
-      identifier is a file called <filename>pwfile</filename>.
+      is contained in a file called <filename>pwfile</filename>.
     </para>
     <para>

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -1095 +1095 @@
   <xi:include href="user_man_VBoxManage-encryptmedium.xml"  xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
-  <sect1 id="vboxmanage-checkmediumpwd">
-
-    <title>VBoxManage checkmediumpwd</title>
-
-    <para>
-      This command is used to check the current encryption password on a
-      DEK encrypted medium or image. See
-      <xref linkend="diskencryption-encryption" />.
-    </para>
-
-    <para>
-      The syntax is as follows:
-    </para>
-
-<screen>VBoxManage checkmediumpwd &lt;uuid|filename&gt;
-                                      &lt;pwd file|-&gt;</screen>
-
-    <itemizedlist>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;uuid|filename&gt;</computeroutput> to
-          supply the UUID or absolute path of the medium or image to be
-          checked.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-          Use <computeroutput>&lt;pwd file|-&gt;</computeroutput> to
-          supply the password identifier to be checked. Either specify
-          the absolute pathname of a password file on the host operating
-          system, or <computeroutput>-</computeroutput> to prompt you
-          for the password on the command line.
-        </para>
-      </listitem>
-
-    </itemizedlist>
-
-  </sect1>
+  <xi:include href="user_man_VBoxManage-checkmediumpwd.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
 
   <sect1 id="vboxmanage-convertfromraw">

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.cpp

@@ -210 +210 @@
     { "clonevdi",           USAGE_S_NEWCMD,  HELP_CMD_CLONEMEDIUM, handleCloneMedium,          0 }, /* backward compatibility */
     { "encryptmedium",      USAGE_S_NEWCMD,HELP_CMD_ENCRYPTMEDIUM, handleEncryptMedium,        0 },
-    { "checkmediumpwd",     USAGE_MEDIUMENCCHKPWD,  VBMG_CMD_TODO, handleCheckMediumPassword,  0 },
+    { "checkmediumpwd",     USAGE_S_NEWCMD,HELP_CMD_CHECKMEDIUMPWD, handleCheckMediumPassword,  0 },
     { "createvm",           USAGE_S_NEWCMD,     HELP_CMD_CREATEVM, handleCreateVM,             0 },
     { "modifyvm",           USAGE_S_NEWCMD,     HELP_CMD_MODIFYVM, handleModifyVM,             0 },

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h

@@ -132 +132 @@
     USAGE_I_REPAIRHD,
     USAGE_NATNETWORK,
-    USAGE_MEDIUMENCCHKPWD,
     USAGE_USBDEVSOURCE,
     /* Insert new entries before this line, but only if it is not an option

trunk/src/VBox/Frontends/VBoxManage/VBoxManageDisk.cpp

@@ -2116 +2116 @@
 
     if (a->argc != 2)
-        return errorSyntax(USAGE_MEDIUMENCCHKPWD, Disk::tr("Invalid number of arguments: %d"), a->argc);
+        return errorSyntax(Disk::tr("Invalid number of arguments: %d"), a->argc);
 
     pszFilenameOrUuid = a->argv[0];

trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp

@@ -639 +639 @@
                      "\n", SEP);
 
-    if (enmCommand == USAGE_MEDIUMENCCHKPWD || enmCommand == USAGE_S_ALL)
-        RTStrmPrintf(pStrm,
-                           "%s checkmediumpwd %s  <uuid|filename>\n"
-                     "                            <pwd file>|-\n"
-                     "\n", SEP);
-
     if (enmCommand == USAGE_CONVERTFROMRAW || enmCommand == USAGE_S_ALL)
         RTStrmPrintf(pStrm,