openstack
/
nova
Code Issues Proposed changes

Fix incorrect statement in inline neutronv2 docs 

The function doc header for network/neutron/v2/api.py _create_port()
states that it accepts an optional set of MAC addresses to use.

However, it only uses one, which is selected by pop().

This commit merely changes the doc string to indicate that the function
operates on only a single MAC address, not on the whole set.

Change-Id: I0fc845572836b6a6773cc7beaeefd7b0d1cfd5e7
Related-bug: #1405131
This commit is contained in:
Devananda van der Veen 2015-03-31 03:37:13 -07:00
parent 9c45ff348d
commit 87cc3928c4
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
nova/network/neutronv2/api.py
View File

@ -276,7 +276,8 @@ class API(base_api.NetworkAPI):
:param fixed_ip: Optional fixed IP to use from the given network. :param fixed_ip: Optional fixed IP to use from the given network.
:param security_group_ids: Optional list of security group IDs to :param security_group_ids: Optional list of security group IDs to
apply to the port. apply to the port.
:param available_macs: Optional set of available MAC addresses to use. :param available_macs: Optional set of available MAC addresses,
from which one will be used at random.
:param dhcp_opts: Optional DHCP options. :param dhcp_opts: Optional DHCP options.
:returns: ID of the created port. :returns: ID of the created port.
:raises PortLimitExceeded: If neutron fails with an OverQuota error. :raises PortLimitExceeded: If neutron fails with an OverQuota error.