openstack/ironic-python-agent
Code Issues Proposed changes

Merge "Fix doc warnings"

Browse Source
This commit is contained in:
Jenkins
2016-07-18 13:58:51 +00:00
committed by Gerrit Code Review
parent 62743fec6a 2e10d7b32c
commit 04c880f6f2
4 changed files with 21 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/index.rst
View File

@@ -12,6 +12,13 @@ provisioning servers.
Throughout the remainder of the document, Ironic Python Agent will be Throughout the remainder of the document, Ironic Python Agent will be
abbreviated to IPA. abbreviated to IPA.
Index
=====
.. toctree::
troubleshooting
How it works How it works
============ ============
@@ -350,4 +357,3 @@ Indices and tables
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`
* :ref:`search` * :ref:`search`
* :ref:`troubleshooting`

2
ironic_python_agent/extensions/iscsi.py
View File

@@ -151,7 +151,7 @@ class ISCSIExtension(base.BaseAgentExtension):
"""Expose the disk as an ISCSI target. """Expose the disk as an ISCSI target.
:param wipe_disk_metadata: if the disk metadata should be wiped out :param wipe_disk_metadata: if the disk metadata should be wiped out
before the disk is exposed. before the disk is exposed.
""" """
# If iqn is not given, generate one # If iqn is not given, generate one
if iqn is None: if iqn is None:

14
ironic_python_agent/hardware.py
View File

@@ -356,12 +356,14 @@ class HardwareManager(object):
If multiple hardware managers return the same step name, the following If multiple hardware managers return the same step name, the following
logic will be used to determine which manager's step "wins": logic will be used to determine which manager's step "wins":
- Keep the step that belongs to HardwareManager with highest
HardwareSupport (larger int) value. * Keep the step that belongs to HardwareManager with highest
- If equal support level, keep the step with the higher defined HardwareSupport (larger int) value.
priority (larger int). * If equal support level, keep the step with the higher defined
- If equal support level and priority, keep the step associated priority (larger int).
with the HardwareManager whose name comes earlier in the alphabet. * If equal support level and priority, keep the step associated
with the HardwareManager whose name comes earlier in the
alphabet.
The steps will be called using `hardware.dispatch_to_managers` and The steps will be called using `hardware.dispatch_to_managers` and
handled by the best suited hardware manager. If you need a step to be handled by the best suited hardware manager. If you need a step to be

10
ironic_python_agent/tests/functional/base.py
View File

@@ -71,13 +71,13 @@ class FunctionalBase(test_base.BaseTestCase):
**kwargs): **kwargs):
"""Send a request to the agent and verifies response. """Send a request to the agent and verifies response.
:param: method type of request to send as a string :param method: type of request to send as a string
:param: path desired API endpoint to request, for example 'commands' :param path: desired API endpoint to request, for example 'commands'
:param: expect_error error code to expect, if an error is expected :param expect_error: error code to expect, if an error is expected
:param: expect_json whether to expect a JSON response. if True, convert :param expect_json: whether to expect a JSON response. if True, convert
it to a dict before returning, otherwise return the it to a dict before returning, otherwise return the
Response object Response object
:param **kwargs: keyword args to pass to the request method :param kwargs: keyword args to pass to the request method
:raises: HTTPError if an error is returned that was not expected :raises: HTTPError if an error is returned that was not expected
:raises: AssertionError if a received HTTP status code does not match :raises: AssertionError if a received HTTP status code does not match
expect_error expect_error