Skip to content

Commit c30657d

Browse files
committed
Cleanup ReST format issues
* ReST doesn't allow monospace in italic sections. bash$ grep -R \`\` doc/build/html/ --include "*.html" * The code-block section "::" needed an empty line before the code, otherwise it gets shown in the HTML output. bash$ egrep -R "<dt>::" doc/build/html/ --include "*.html" * Monospaced font incorrectly marked with a single back tick bash$ egrep -nR '\w`(\s|[\.,;:])' doc/source/ --include "*.rst" Change-Id: I66c3f685f33851c3f3f0f859996037fc24930246
1 parent a9e92c2 commit c30657d

4 files changed

Lines changed: 33 additions & 32 deletions

File tree

doc/source/configuration.rst

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -202,8 +202,8 @@ process to a file in ``LOGDIR``.
202202

203203
LOGDIR=$DEST/logs
204204

205-
*Note the use of ``DEST`` to locate the main install directory; this
206-
is why we suggest setting it in ``local.conf``.*
205+
Note the use of ``DEST`` to locate the main install directory; this
206+
is why we suggest setting it in ``local.conf``.
207207

208208
Enabling Syslog
209209
~~~~~~~~~~~~~~~
@@ -239,15 +239,15 @@ Database Backend
239239

240240
Multiple database backends are available. The available databases are defined
241241
in the lib/databases directory.
242-
`mysql` is the default database, choose a different one by putting the
243-
following in the `localrc` section:
242+
``mysql`` is the default database, choose a different one by putting the
243+
following in the ``localrc`` section:
244244

245245
::
246246

247247
disable_service mysql
248248
enable_service postgresql
249249

250-
`mysql` is the default database.
250+
``mysql`` is the default database.
251251

252252
RPC Backend
253253
-----------
@@ -260,6 +260,7 @@ RabbitMQ is handled via the usual service functions and
260260
Example disabling RabbitMQ in ``local.conf``:
261261

262262
::
263+
263264
disable_service rabbit
264265

265266

@@ -511,15 +512,15 @@ VM. When running with only one replica the account, container and
511512
object services will run directly in screen. The others services like
512513
replicator, updaters or auditor runs in background.
513514

514-
If you would like to enable Swift you can add this to your `localrc`
515+
If you would like to enable Swift you can add this to your ``localrc``
515516
section:
516517

517518
::
518519

519520
enable_service s-proxy s-object s-container s-account
520521

521522
If you want a minimal Swift install with only Swift and Keystone you
522-
can have this instead in your `localrc` section:
523+
can have this instead in your ``localrc`` section:
523524

524525
::
525526

@@ -528,24 +529,24 @@ can have this instead in your `localrc` section:
528529

529530
If you only want to do some testing of a real normal swift cluster
530531
with multiple replicas you can do so by customizing the variable
531-
`SWIFT_REPLICAS` in your `localrc` section (usually to 3).
532+
``SWIFT_REPLICAS`` in your ``localrc`` section (usually to 3).
532533

533534
Swift S3
534535
++++++++
535536

536-
If you are enabling `swift3` in `ENABLED_SERVICES` DevStack will
537+
If you are enabling ``swift3`` in ``ENABLED_SERVICES`` DevStack will
537538
install the swift3 middleware emulation. Swift will be configured to
538539
act as a S3 endpoint for Keystone so effectively replacing the
539-
`nova-objectstore`.
540+
``nova-objectstore``.
540541

541542
Only Swift proxy server is launched in the screen session all other
542-
services are started in background and managed by `swift-init` tool.
543+
services are started in background and managed by ``swift-init`` tool.
543544

544545
Heat
545546
~~~~
546547

547-
Heat is disabled by default (see `stackrc` file). To enable it
548-
explicitly you'll need the following settings in your `localrc`
548+
Heat is disabled by default (see ``stackrc`` file). To enable it
549+
explicitly you'll need the following settings in your ``localrc``
549550
section
550551

551552
::
@@ -554,7 +555,7 @@ section
554555

555556
Heat can also run in standalone mode, and be configured to orchestrate
556557
on an external OpenStack cloud. To launch only Heat in standalone mode
557-
you'll need the following settings in your `localrc` section
558+
you'll need the following settings in your ``localrc`` section
558559

559560
::
560561

@@ -590,14 +591,14 @@ Xenserver
590591
~~~~~~~~~
591592

592593
If you would like to use Xenserver as the hypervisor, please refer to
593-
the instructions in `./tools/xen/README.md`.
594+
the instructions in ``./tools/xen/README.md``.
594595

595596
Cells
596597
~~~~~
597598

598599
`Cells <http://wiki.openstack.org/blueprint-nova-compute-cells>`__ is
599600
an alternative scaling option. To setup a cells environment add the
600-
following to your `localrc` section:
601+
following to your ``localrc`` section:
601602

602603
::
603604

doc/source/guides/devstack-with-lbaas-v2.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Install devstack
1717
cd devstack
1818

1919

20-
Edit your `local.conf` to look like
20+
Edit your ``local.conf`` to look like
2121

2222
::
2323

doc/source/guides/devstack-with-nested-kvm.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ the host:
5050
parm: nested:bool
5151

5252
Start your VM, now it should have KVM capabilities -- you can verify
53-
that by ensuring `/dev/kvm` character device is present.
53+
that by ensuring ``/dev/kvm`` character device is present.
5454

5555

5656
Configure Nested KVM for AMD-based Machines
@@ -97,7 +97,7 @@ To make the above value persistent across reboots, add an entry in
9797
Expose Virtualization Extensions to DevStack VM
9898
-----------------------------------------------
9999

100-
Edit the VM's libvirt XML configuration via `virsh` utility:
100+
Edit the VM's libvirt XML configuration via ``virsh`` utility:
101101

102102
::
103103

@@ -115,10 +115,10 @@ Ensure DevStack VM is Using KVM
115115
-------------------------------
116116

117117
Before invoking ``stack.sh`` in the VM, ensure that KVM is enabled. This
118-
can be verified by checking for the presence of the file `/dev/kvm` in
118+
can be verified by checking for the presence of the file ``/dev/kvm`` in
119119
your VM. If it is present, DevStack will default to using the config
120-
attribute `virt_type = kvm` in `/etc/nova.conf`; otherwise, it'll fall
121-
back to `virt_type=qemu`, i.e. plain QEMU emulation.
120+
attribute ``virt_type = kvm`` in ``/etc/nova.conf``; otherwise, it'll fall
121+
back to ``virt_type=qemu``, i.e. plain QEMU emulation.
122122

123123
Optionally, to explicitly set the type of virtualization, to KVM, by the
124124
libvirt driver in nova, the below config attribute can be used in
@@ -131,7 +131,7 @@ DevStack's ``local.conf``:
131131

132132
Once DevStack is configured successfully, verify if the Nova instances
133133
are using KVM by noticing the QEMU CLI invoked by Nova is using the
134-
parameter `accel=kvm`, e.g.:
134+
parameter ``accel=kvm``, e.g.:
135135

136136
::
137137

doc/source/guides/neutron.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,8 @@ nova, neutron)
170170
**Compute Nodes**
171171

172172
In this example, the nodes that will host guest instances will run
173-
the `neutron-openvswitch-agent` for network connectivity, as well as
174-
the compute service `nova-compute`.
173+
the ``neutron-openvswitch-agent`` for network connectivity, as well as
174+
the compute service ``nova-compute``.
175175

176176
DevStack Configuration
177177
----------------------
@@ -256,16 +256,16 @@ compute node 1.
256256
Q_L3_ENABLED=False
257257

258258
Compute node 2's configuration will be exactly the same, except
259-
`HOST_IP` will be `10.0.0.4`
259+
``HOST_IP`` will be ``10.0.0.4``
260260

261261
When DevStack is configured to use provider networking (via
262-
`Q_USE_PROVIDER_NETWORKING` is True and `Q_L3_ENABLED` is False) -
262+
``Q_USE_PROVIDER_NETWORKING`` is True and ``Q_L3_ENABLED`` is False) -
263263
DevStack will automatically add the network interface defined in
264-
`PUBLIC_INTERFACE` to the `OVS_PHYSICAL_BRIDGE`
264+
``PUBLIC_INTERFACE`` to the ``OVS_PHYSICAL_BRIDGE``
265265

266266
For example, with the above configuration, a bridge is
267-
created, named `br-ex` which is managed by Open vSwitch, and the
268-
second interface on the compute node, `eth1` is attached to the
267+
created, named ``br-ex`` which is managed by Open vSwitch, and the
268+
second interface on the compute node, ``eth1`` is attached to the
269269
bridge, to forward traffic sent by guest VMs.
270270

271271
Miscellaneous Tips
@@ -307,7 +307,7 @@ Configuring Extension Drivers for the ML2 Plugin
307307
------------------------------------------------
308308

309309
Extension drivers for the ML2 plugin are set with the variable
310-
`Q_ML2_PLUGIN_EXT_DRIVERS`, and includes the 'port_security' extension
310+
``Q_ML2_PLUGIN_EXT_DRIVERS``, and includes the 'port_security' extension
311311
by default. If you want to remove all the extension drivers (even
312-
'port_security'), set `Q_ML2_PLUGIN_EXT_DRIVERS` to blank.
312+
'port_security'), set ``Q_ML2_PLUGIN_EXT_DRIVERS`` to blank.
313313

0 commit comments

Comments
 (0)