Changeset 79853 in vbox

Timestamp:

Jul 18, 2019 8:34:51 AM (5 years ago)

Author:

vboxsync

Message:

man_VBoxManage-dhcpserver.xml: Include DHCP option details from VirtualBox.xidl. Due to complicated dependencies and expecting very low update volume, we just check in the generated include file. bugref:9288

Location:

trunk

Files:

• doc/manual/Makefile.kmk (modified) (1 diff)
• doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml (added)
• doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl (added)
• doc/manual/en_US/man_VBoxManage-dhcpserver.xml (modified) (1 diff)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (3 diffs)

trunk/doc/manual/Makefile.kmk

@@ -878 +878 @@
                         ,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
 
+#
+# Manually updating the DHCP option list taken from VirtualBox.xidl
+#
+dhcpoptions: $(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl \
+                $(PATH_ROOT)/src/VBox/Main/idl/VirtualBox.xidl
+        $(call VBOX_XSLTPROC) --output "$(PATH_ROOT)/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml" $+
 
 

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

@@ -497 +497 @@
     </refsect2>
 
+    <refsect2 id="vboxmanage-dhcpserver-dhcpoptions">
+      <title>Common DHCP Options:</title>
+      <remark role="help-scope" condition="DHCPSERVER_ADD|DHCPSERVER_MODIFY"/>
+      <!-- The following file is generated from src/VBox/Main/idl/VirtualBox.xidl: -->
+      <xi:include href="man_VBoxManage-dhcpserver-dhcpoptions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    </refsect2>
+
   </refsect1>
 

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -1833 +1833 @@
       name="DHCPOption"
       uuid="00f5b10f-0021-4513-00f7-5bf4000982bf">
-    <!-- Names should exactly match those given in DhcpOptions.h. -->
-    <!-- Note! we use the descriptions here in the VBoxManage man page / manual. Everything must be propertly described. -->
+    <!-- Names should exactly match those given in DhcpOptions.h.
+         Everything must be documented properly.
+
+         Note! We use these descriptions in the VBoxManage man page / manual.
+               When making changes remember to regenerate the man page bits:
+                    kmk -C doc/manual dhcpoptions
+      -->
     <const name="SubnetMask"              value="1"><desc>IPv4 netmask. Set to <link to="IDHCPServer::networkMask"/> by default.</desc></const>
     <const name="TimeOffset"              value="2"><desc>UTC offset in seconds (32-bit decimal value).</desc></const>
@@ -1877 +1882 @@
     <const name="NISServers"              value="41"><desc>Space separated list of IPv4 NIS server addresses.</desc></const>
     <const name="NTPServers"              value="42"><desc>Space separated list of IPv4 NTP (RFC1035) server addresses.</desc></const>
-    <const name="VendorSpecificInfo"      value="43"><desc>Vendor specific information. Only <link to="DHCPOptionEncoding::Hex"/></desc></const>
-    <const name="NetBIOSNameServers"      value="44"><desc>Space separated list of IPv4 NetBIOS name server (NBNS) addresses ((RFC1001,RFC1002).</desc></const>
+    <const name="VendorSpecificInfo"      value="43"><desc>Vendor specific information. Only accessible via <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
+    <const name="NetBIOSNameServers"      value="44"><desc>Space separated list of IPv4 NetBIOS name server (NBNS) addresses (RFC1001,RFC1002).</desc></const>
     <const name="NetBIOSDatagramServers"  value="45"><desc>Space separated list of IPv4 NetBIOS datagram distribution server (NBDD) addresses (RFC1001,RFC1002).</desc></const>
     <const name="NetBIOSNodeType"         value="46"><desc>NetBIOS node type (RFC1001,RFC1002): 1=B-node, 2=P-node, 4=M-node, and 8=H-node (8-bit decimal value).</desc></const>
-    <const name="NetBIOSScope"            value="47"><desc>NetBIOS scope (RFC1001,RFC1002). Only <link to="DHCPOptionEncoding::Hex"/></desc></const>
+    <const name="NetBIOSScope"            value="47"><desc>NetBIOS scope (RFC1001,RFC1002). Only accessible via <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
     <const name="XWindowsFontServers"     value="48"><desc>Space separated list of IPv4 X windows font server addresses.</desc></const>
     <const name="XWindowsDisplayManager"  value="49"><desc>Space separated list of IPv4 X windows display manager addresses.</desc></const>
     <!-- Options 50 thru 59 are considered DHCP internal and currently not settable. -->
     <const name="NetWareIPDomainName"     value="62"><desc>Netware IP domain name (RFC2242) (string).</desc></const>
-    <const name="NetWareIPInformation"    value="63"><desc>Netware IP information (RFC2242). Only <link to="DHCPOptionEncoding::Hex"/></desc></const>
+    <const name="NetWareIPInformation"    value="63"><desc>Netware IP information (RFC2242). Only accessible via <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
     <const name="NISPlusDomain"           value="64"><desc>The NIS+ domain name (string).</desc></const>
     <const name="NISPlusServers"          value="65"><desc>Space separated list of IPv4 NIS+ server addresses.</desc></const>
@@ -1901 +1906 @@
     <const name="STDAServers"             value="76"><desc>Space separated list of IPv4 StreetTalk directory assistance (STDA) server addresses.</desc></const>
     <!-- 77 is client only -->
-    <const name="SLPDirectoryAgent"       value="78"><desc>Addresses of one or more service location protocol (SLP) directory agent, and an indicator of whether their use is mandatory. Only <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
-    <const name="SLPServiceScope"         value="79"><desc>List of service scopes for the service location protocol (SLP) and whether using the list is mandator. Only <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
+    <const name="SLPDirectoryAgent"       value="78"><desc>Addresses of one or more service location protocol (SLP) directory agent, and an indicator of whether their use is mandatory. Only accessible via <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
+    <const name="SLPServiceScope"         value="79"><desc>List of service scopes for the service location protocol (SLP) and whether using the list is mandator. Only accessible via <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
     <!-- 80 is client only -->
-    <const name="DomainSearch"            value="119"><desc>Domain search list, see RFC3397 and section 4.1.4 in RFC1035 for encoding.  Only <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
+    <const name="DomainSearch"            value="119"><desc>Domain search list, see RFC3397 and section 4.1.4 in RFC1035 for encoding.  Only accessible via <link to="DHCPOptionEncoding::Hex"/>.</desc></const>
   </enum>