doc: Minor updates.

Signed-off-by: John Wilkins <john.wilkins@inktank.com>

diff --git a/doc/rados/configuration/journal-ref.rst b/doc/rados/configuration/journal-ref.rst
index 3937d03661486b0bad2a3fef0618864004b832b4..b7344544b9aaef70ddc030cffa85c83ee4c13b63 100644 (file)
--- a/doc/rados/configuration/journal-ref.rst
+++ b/doc/rados/configuration/journal-ref.rst
@@ -2,30 +2,36 @@
  Journal Config Reference
 ==========================
 
+.. index:: journal; journal configuration
+
 Ceph OSDs use a journal for two reasons: speed and consistency.  
 
-- **Speed:** The journal enables the OSD to commit small writes quickly. 
-  Ceph writes small, random i/o to the journal sequentially, which tends to
-  speed up bursty workloads by allowing the backing filesystem more time to 
-  coalesce writes. The OSD journal, however, can lead to spiky performance 
-  with short spurts of high-speed writes followed by periods without any
-  write progress as the filesystem catches up to the journal.
-
-- **Consistency:** Ceph OSDs require a filesystem interface that guarantees
-  atomic compound operations. Ceph OSDs write a description of the operation
-  to the journal and apply the operation to the filesystem. This enables 
-  atomic updates to an object (for example, placement group metadata). Every 
-  few seconds--between ``filestore max sync interval`` and
-  ``filestore min sync interval``--the OSD stops writes and synchronizes the
-  journal with the filesystem, allowing OSDs to trim operations from the
-  journal and reuse the space. On failure, OSDs replay the journal starting
-  after the last synchronization operation.
-
-Ceph OSDs support the following journal settings: 
+- **Speed:** The journal enables the Ceph OSD Daemon to commit small writes 
+  quickly. Ceph writes small, random i/o to the journal sequentially, which 
+  tends to speed up bursty workloads by allowing the backing filesystem more 
+  time to coalesce writes. The Ceph OSD Daemon's journal, however, can lead 
+  to spiky performance with short spurts of high-speed writes followed by 
+  periods without any write progress as the filesystem catches up to the 
+  journal.
+
+- **Consistency:** Ceph OSD Daemons require a filesystem interface that 
+  guarantees atomic compound operations. Ceph OSD Daemons write a description 
+  of the operation to the journal and apply the operation to the filesystem. 
+  This enables atomic updates to an object (for example, placement group 
+  metadata). Every few seconds--between ``filestore max sync interval`` and
+  ``filestore min sync interval``--the Ceph OSD Daemon stops writes and 
+  synchronizes the journal with the filesystem, allowing Ceph OSD Daemons to 
+  trim operations from the journal and reuse the space. On failure, Ceph 
+  OSD Daemons replay the journal starting after the last synchronization 
+  operation.
+
+Ceph OSD Daemons support the following journal settings: 
 
 ``journal dio``
 
-:Description: Enables direct i/o to the journal. Requires ``journal block align`` set to ``true``.
+:Description: Enables direct i/o to the journal. Requires ``journal block 
+              align`` set to ``true``.
+              
 :Type: Boolean
 :Required: Yes when using ``aio``.
 :Default: ``true``
@@ -33,7 +39,9 @@ Ceph OSDs support the following journal settings:
 
 ``journal aio``
 
-:Description: Enables using ``libaio`` for asynchronous writes to the journal. Requires ``journal dio`` set to ``true``.
+:Description: Enables using ``libaio`` for asynchronous writes to the journal. 
+              Requires ``journal dio`` set to ``true``.
+
 :Type: Boolean 
 :Required: No.
 :Default: ``false``
@@ -41,7 +49,7 @@ Ceph OSDs support the following journal settings:
 
 ``journal block align``
 
-:Description: Block aligns writes. Required for ``dio`` and ``aio``.
+:Description: Block aligns write operations. Required for ``dio`` and ``aio``.
 :Type: Boolean
 :Required: Yes when using ``dio`` and ``aio``.
 :Default: ``true``
@@ -49,7 +57,9 @@ Ceph OSDs support the following journal settings:
 
 ``journal max write bytes``
 
-:Description: The maximum number of bytes the journal will write at any one time.
+:Description: The maximum number of bytes the journal will write at 
+              any one time.
+
 :Type: Integer
 :Required: No
 :Default: ``10 << 20``
@@ -57,7 +67,9 @@ Ceph OSDs support the following journal settings:
 
 ``journal max write entries``
 
-:Description: The maximum number of entries the journal will write at any one time.
+:Description: The maximum number of entries the journal will write at 
+              any one time.
+
 :Type: Integer
 :Required: No
 :Default: ``100``
@@ -65,7 +77,9 @@ Ceph OSDs support the following journal settings:
 
 ``journal queue max ops``
 
-:Description: The maximum number of operations allowed in the queue at any one time.
+:Description: The maximum number of operations allowed in the queue at 
+              any one time.
+
 :Type: Integer
 :Required: No
 :Default: ``500``
@@ -73,7 +87,9 @@ Ceph OSDs support the following journal settings:
 
 ``journal queue max bytes``
 
-:Description: The maximum number of bytes allowed in the queue at any one time.
+:Description: The maximum number of bytes allowed in the queue at 
+              any one time.
+
 :Type: Integer
 :Required: No
 :Default: ``10 << 20``
@@ -89,7 +105,8 @@ Ceph OSDs support the following journal settings:
 
 ``journal zero on create``
 
-:Description: Causes the file store to overwrite the entire journal with ``0``'s during ``mkfs``.
+:Description: Causes the file store to overwrite the entire journal with 
+              ``0``'s during ``mkfs``.
 :Type: Boolean
 :Required: No
 :Default: ``false``