openstack/ironic
Code Issues Proposed changes

Fix drivers.rst doc format error

Browse Source 
This fixes rst document format error of drivers.rst
before merging irmc sub section of iRMC Power Driver
(blueprint irmc-power-driver).

$ doc8 doc/source/deploy/drivers.rst
Scanning...
Validating...
doc/source/deploy/drivers.rst:13: D001 Line too long
doc/source/deploy/drivers.rst:43: D001 Line too long
doc/source/deploy/drivers.rst:58: D001 Line too long
========
Total files scanned = 1
Total files ignored = 0
Total accumulated errors = 3
Detailed error counts:
    - doc8.checks.CheckCarriageReturn = 0
    - doc8.checks.CheckIndentationNoTab = 0
    - doc8.checks.CheckMaxLineLength = 3
    - doc8.checks.CheckNewlineEndOfFile = 0
    - doc8.checks.CheckTrailingWhitespace = 0
    - doc8.checks.CheckValidity = 0

Change-Id: I1e130fb0abdb2a78f9d4ceb3f7823b079769b510
This commit is contained in:
Naohiro Tamura 2015-01-28 11:16:44 +09:00
parent cee9594382
commit 9b61ae492e
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/deploy/drivers.rst Normal file → Executable file
View File

@ -10,7 +10,8 @@ DRAC
DRAC with PXE deploy
^^^^^^^^^^^^^^^^^^^^
- Add ``pxe_drac`` to the list of ``enabled_drivers in`` ``/etc/ironic/ironic.conf``
- Add ``pxe_drac`` to the list of ``enabled_drivers in``
``/etc/ironic/ironic.conf``
- Install openwsman-python package
SNMP
@ -40,7 +41,8 @@ Software Requirements
Enabling the SNMP Power Driver
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Add ``pxe_snmp`` to the list of ``enabled_drivers`` in ``/etc/ironic/ironic.conf``
- Add ``pxe_snmp`` to the list of ``enabled_drivers`` in
``/etc/ironic/ironic.conf``
- Ironic Conductor must be restarted for the new driver to be loaded.
Ironic Node Configuration
@ -55,7 +57,8 @@ added to ``driver_info``:
If not specified, the default port (161) is used.
- ``snmp_outlet``: The power outlet on the PDU (1-based indexing).
- ``snmp_protocol``: (optional) SNMP protocol version
(permitted values ``1``, ``2c`` or ``3``). If not specified, SNMPv1 is chosen.
(permitted values ``1``, ``2c`` or ``3``). If not specified, SNMPv1
is chosen.
- ``snmp_community``: (Required for SNMPv1 and SNMPv2c) SNMP community
parameter for reads and writes to the PDU.
- ``snmp_security``: (Required for SNMPv3) SNMP security string.