openstack/ironic-python-agent
Code Issues Proposed changes

Fix to preserve double dashes of command line option in HTML.

Browse Source 
This patch fixes the ReST doc so that generated HTML file can keep
double dashes of command line option by enclosing the option in double
back quote such as ``--standalone`` and ``--debug``.

Change-Id: Icf25ff8ddfb7c04d82d6e63885cad0ec62e86cba
This commit is contained in:
Naohiro Tamura 2015-11-16 09:29:50 +09:00
parent 59630d4f7b
commit 505b34575c
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/index.rst
View File

@ -134,14 +134,14 @@ You can pass a variety of flags to IPA on start up to change its behavior.
If you're using the CoreOS image, you can modify the
ironic-python-agent.service unit in cloud-config.yaml [5]_.
* --standalone: This disables the initial lookup and heartbeats to Ironic.
* ``--standalone``: This disables the initial lookup and heartbeats to Ironic.
Lookup sends some information to Ironic in order to determine Ironic's node
UUID for the node. Heartbeat sends periodic pings to Ironic to tell Ironic
the node is still running. These heartbeats also trigger parts of the deploy
and cleaning cycles. This flag is useful for debugging IPA without an Ironic
installation.
* --debug: Enables debug logging.
* ``--debug``: Enables debug logging.
Hardware Managers