diff --git a/scripts/base/protocols/dhcp/consts.bro b/scripts/base/protocols/dhcp/consts.bro index 1b2a271563..5afdfc9415 100644 --- a/scripts/base/protocols/dhcp/consts.bro +++ b/scripts/base/protocols/dhcp/consts.bro @@ -5,7 +5,7 @@ module DHCP; export { - ## Types of DHCP messages. See RFC 1533. + ## Types of DHCP messages. See :rfc:`1533`. const message_types = { [1] = "DHCP_DISCOVER", [2] = "DHCP_OFFER", diff --git a/scripts/base/protocols/dhcp/main.bro b/scripts/base/protocols/dhcp/main.bro index 144e5a53e7..e5be50b1ab 100644 --- a/scripts/base/protocols/dhcp/main.bro +++ b/scripts/base/protocols/dhcp/main.bro @@ -3,7 +3,8 @@ ##! noisy on most networks, and focuses on the end-result: assigned leases. ##! ##! If you'd like to track known DHCP devices and to log the hostname -##! supplied by the client, see policy/protocols/dhcp/known-devices.bro +##! supplied by the client, see +##! :doc:`/scripts/policy/protocols/dhcp/known-devices-and-hostnames`. @load ./utils.bro @@ -18,7 +19,7 @@ export { ## associated connection is observed. ts: time &log; ## A unique identifier of the connection over which DHCP is - ## occuring. + ## occurring. uid: string &log; ## The connection's 4-tuple of endpoint addresses/ports. id: conn_id &log; @@ -28,7 +29,7 @@ export { assigned_ip: addr &log &optional; ## IP address lease interval. lease_time: interval &log &optional; - ## A random number choosen by the client for this transaction. + ## A random number chosen by the client for this transaction. trans_id: count &log; }; @@ -37,7 +38,7 @@ export { global log_dhcp: event(rec: Info); } -# Add the dhcp info to the connection record +# Add the dhcp info to the connection record. redef record connection += { dhcp: Info &optional; }; diff --git a/scripts/base/protocols/dhcp/utils.bro b/scripts/base/protocols/dhcp/utils.bro index ef4f244d8a..e49bfe6af9 100644 --- a/scripts/base/protocols/dhcp/utils.bro +++ b/scripts/base/protocols/dhcp/utils.bro @@ -3,11 +3,11 @@ module DHCP; export { - ## Reverse the octets of an IPv4 IP. + ## Reverse the octets of an IPv4 address. ## - ## ip: An :bro:type:`addr` IPv4 address. + ## ip: An IPv4 address. ## - ## Returns: A reversed addr. + ## Returns: A reversed IPv4 address. global reverse_ip: function(ip: addr): addr; }