]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/radosgw: Cosmetic and formatting improvements in frontends.rst 63156/head
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Wed, 7 May 2025 08:15:32 +0000 (15:15 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Wed, 7 May 2025 08:15:32 +0000 (15:15 +0700)
Capitalize terms like IPv4, SSL, URI consistently.

Title case for "Ceph Monitor".

Fix "Nagel" to "Nagle".

Use inline code consistently in references to configuration values and
reference to "beast" front-end.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
doc/radosgw/frontends.rst

index bf46e3cc15a112833d3e30ab93338ec27e70d9fa..890d0d889f6d01a8bee7d8f4e799d0798c019113 100644 (file)
@@ -23,7 +23,7 @@ Options
 
 ``port`` and ``ssl_port``
 
-:Description: Sets the ipv4 & ipv6 listening port number. Can be specified multiple
+:Description: Sets the IPv4 & IPv6 listening port number. Can be specified multiple
               times as in ``port=80 port=8000``.
 :Type: Integer
 :Default: ``80``
@@ -34,7 +34,7 @@ Options
 :Description: Sets the listening address in the form ``address[:port]``, where
               the address is an IPv4 address string in dotted decimal form, or
               an IPv6 address in hexadecimal notation surrounded by square
-              brackets. Specifying a IPv6 endpoint would listen to v6 only. The
+              brackets. Specifying a IPv6 endpoint would listen to IPv6 only. The
               optional port defaults to 80 for ``endpoint`` and 443 for
               ``ssl_endpoint``. Can be specified multiple times as in
               ``endpoint=[::1] endpoint=192.168.0.100:8000``.
@@ -47,7 +47,7 @@ Options
 
 :Description: Path to the SSL certificate file used for SSL-enabled endpoints.
               If path is prefixed with ``config://``, the certificate will be
-              pulled from the ceph monitor ``config-key`` database.
+              pulled from the Ceph Monitor ``config-key`` database.
 
 :Type: String
 :Default: None
@@ -59,14 +59,14 @@ Options
               endpoints. If one is not given, the ``ssl_certificate`` file
               is used as the private key.
               If path is prefixed with ``config://``, the certificate will be
-              pulled from the ceph monitor ``config-key`` database.
+              pulled from the Ceph Monitor ``config-key`` database.
 
 :Type: String
 :Default: None
 
 ``ssl_options``
 
-:Description: Optional colon separated list of ssl context options:
+:Description: Optional colon separated list of SSL context options:
 
               ``default_workarounds`` Implement various bug workarounds.
 
@@ -102,12 +102,12 @@ Options
               the connection which means that packets will be sent as soon 
               as possible instead of waiting for a full buffer or timeout to occur.
 
-              ``1`` Disable Nagel's algorithm for all sockets.
+              ``1`` Disable Nagle's algorithm for all sockets.
 
-              ``0`` Keep the default: Nagel's algorithm enabled.
+              ``0`` Keep the default: Nagle's algorithm enabled.
 
 :Type: Integer (0 or 1)
-:Default: 0
+:Default: ``0``
 
 ``max_connection_backlog``
 
@@ -120,9 +120,9 @@ Options
 
 ``request_timeout_ms``
 
-:Description: The amount of time in milliseconds that Beast will wait
+:Description: The amount of time in milliseconds that ``beast`` will wait
               for more incoming data or outgoing data before giving up.
-              Setting this value to 0 will disable timeout.
+              Setting this value to ``0`` will disable timeout.
 
 :Type: Integer
 :Default: ``65000``
@@ -144,7 +144,7 @@ Options
               ``0`` Disallow running multiple RGW on same port.
 
 :Type: Integer (0 or 1)
-:Default: 0
+:Default: ``0``
 
 
 Generic Options
@@ -156,7 +156,7 @@ Some frontend options are generic and supported by all frontends:
 
 :Description: A prefix string that is inserted into the URI of all
               requests. For example, a swift-only frontend could supply
-              a uri prefix of ``/swift``.
+              a URI prefix of ``/swift``.
 
 :Type: String
 :Default: None