luci-lib-ip: support specifying source address in route()
[project/luci.git] / libs / luci-lib-ip / src / ip.luadoc
index a2df96cdb5c6c1fbbe161b40bcd683c4d7594cae..afd171bebf6d00179733054bce9a86b3e0cd6515 100644 (file)
@@ -178,6 +178,8 @@ Determine the route leading to the given destination.
 @name route
 @param address A `luci.ip.cidr` instance or a string containing
 a valid IPv4 or IPv6 range as specified by `luci.ip.new()`.
+@param source   A `luci.ip.cidr` instance or a string containing
+the preferred source address for route selection (optional).
 @return <p>Table containing the fields described below.</p>
 <table id="routetable">
 <tr><th>Field</th><th>Description</th></tr>