summaryrefslogtreecommitdiffstats
path: root/src/net/udp/dhcp.c
diff options
context:
space:
mode:
authorMichael Brown2006-07-20 04:23:42 +0200
committerMichael Brown2006-07-20 04:23:42 +0200
commit764cb41456d4a66bb3ae809de48b289ab3367d61 (patch)
tree85cff62cd298fc22f4166d771e46d67d69deb556 /src/net/udp/dhcp.c
parentNow successfully negotiates the whole DHCPDISCOVER/OFFER/REQUEST/ACK (diff)
downloadipxe-764cb41456d4a66bb3ae809de48b289ab3367d61.tar.gz
ipxe-764cb41456d4a66bb3ae809de48b289ab3367d61.tar.xz
ipxe-764cb41456d4a66bb3ae809de48b289ab3367d61.zip
Document memory ownership.
Diffstat (limited to 'src/net/udp/dhcp.c')
-rw-r--r--src/net/udp/dhcp.c5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/net/udp/dhcp.c b/src/net/udp/dhcp.c
index 3a1951cf..466259ae 100644
--- a/src/net/udp/dhcp.c
+++ b/src/net/udp/dhcp.c
@@ -650,6 +650,11 @@ static struct udp_operations dhcp_udp_operations = {
*
* @v dhcp DHCP session
* @ret aop Asynchronous operation
+ *
+ * If the DHCP operation completes successfully, the
+ * dhcp_session::options field will be filled in with the resulting
+ * options block. The caller takes responsibility for eventually
+ * calling free_dhcp_options().
*/
struct async_operation * start_dhcp ( struct dhcp_session *dhcp ) {
int rc;