changeset 1324:f5a5cdd6afe0

* doc/tcpip.sgml: Added documentation for CYGOPT_NET_DHCP_OPTION_HOST_NAME, CYGNUM_NET_DHCP_OPTION_HOST_NAME_LEN, CYGOPT_NET_DHCP_OPTION_DHCP_CLIENTID_MAC, CYGOPT_NET_DHCP_PARM_REQ_LIST_REPLACE and CYGOPT_NET_DHCP_PARM_REQ_LIST_ADDITIONAL. * cdl/net.cdl: Added legal_values definition for the CYGNUM_NET_DHCP_OPTION_HOST_NAME_LEN option.
author asl
date Tue, 21 Oct 2003 18:14:20 +0000
parents 16a975af0355
children 921f9882bd6d
files packages/net/common/current/ChangeLog packages/net/common/current/cdl/net.cdl packages/net/common/current/doc/tcpip.sgml
diffstat 3 files changed, 38 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/packages/net/common/current/ChangeLog
+++ b/packages/net/common/current/ChangeLog
@@ -1,3 +1,15 @@
+2003-10-16  Jay Foster  <jay@systech.com>
+            Andrew Lunn <andrew.lunn@ascom.ch>
+	
+         * doc/tcpip.sgml: Added documentation for
+         CYGOPT_NET_DHCP_OPTION_HOST_NAME, 
+         CYGNUM_NET_DHCP_OPTION_HOST_NAME_LEN,
+         CYGOPT_NET_DHCP_OPTION_DHCP_CLIENTID_MAC,
+         CYGOPT_NET_DHCP_PARM_REQ_LIST_REPLACE and
+         CYGOPT_NET_DHCP_PARM_REQ_LIST_ADDITIONAL.
+         * cdl/net.cdl: Added legal_values definition for the 
+         CYGNUM_NET_DHCP_OPTION_HOST_NAME_LEN option.
+ 
 2003-10-21  Andrew Lunn  <andrew.lunn@ascom.ch>
 
         * src/dhcp_prot.c (set_default_dhcp_tags): 
--- a/packages/net/common/current/cdl/net.cdl
+++ b/packages/net/common/current/cdl/net.cdl
@@ -283,6 +283,7 @@ cdl_package CYGPKG_NET {
                 display "DHCP host name maximum length"
                 flavor  data
                 default_value 60
+                legal_values 0 to 255
                 active_if CYGOPT_NET_DHCP_OPTION_HOST_NAME
                 description "
                     This option defines the maximum length allowed for the 
--- a/packages/net/common/current/doc/tcpip.sgml
+++ b/packages/net/common/current/doc/tcpip.sgml
@@ -608,6 +608,31 @@ thread will shut down all interfaces and
 the interfaces again from scratch.  This may cause chaos in the
 app, which is why managing the DHCP state in an application aware
 thread is actually better, just far less convenient for testing.</PARA>
+
+<PARA>If the configuration option CYGOPT_NET_DHCP_OPTION_HOST_NAME
+is defined, then the TAG_HOST_NAME DHCP option will be included
+in any DHCP lease requests.  The text for the hostname is set by
+calling <function>dhcp_set_hostname()</function>.  Any DHCP lease requests
+made prior to calling <function>dhcp_set_hostname()</function> will not
+include the TAG_HOST_NAME DHCP option.  The configuration option
+CYGNUM_NET_DHCP_OPTION_HOST_NAME_LEN controls the maximum length allowed
+for the hostname.  This permits the hostname text to be determined at
+run-time.  Setting the hostname to the empty string will have the effect
+of disabling the TAG_HOST_NAME DHCP option.</PARA>
+<PARA>If the configuration option CYGOPT_NET_DHCP_OPTION_DHCP_CLIENTID_MAC
+is defined, then the TAG_DHCP_CLIENTID DHCP option will be included
+in any DHCP lease requests.  The client ID used will be the current
+MAC address of the network interface.</PARA>
+
+<PARA>The option CYGOPT_NET_DHCP_PARM_REQ_LIST_ADDITIONAL allows
+additional DHCP options to be added to the request sent to the DHCP
+server. This option should be set to a comma separated list of options.
+</PARA>
+
+<PARA> The option CYGOPT_NET_DHCP_PARM_REQ_LIST_REPLACE is similar to
+CYGOPT_NET_DHCP_PARM_REQ_LIST_ADDITIONAL but in this case it
+completely replaces the default list of options with the configured
+set of comma separated options.</para>
 </SECT1>
 </CHAPTER>
     &net-common-tcpip-manpages-sgml;