Skip to content

Commit 7e92fd1

Browse files
committed
doc/radosgw: Cosmetic and formatting improvements in frontends.rst
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 <[email protected]>
1 parent 9238442 commit 7e92fd1

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

doc/radosgw/frontends.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Options
2323

2424
``port`` and ``ssl_port``
2525

26-
:Description: Sets the ipv4 & ipv6 listening port number. Can be specified multiple
26+
:Description: Sets the IPv4 & IPv6 listening port number. Can be specified multiple
2727
times as in ``port=80 port=8000``.
2828
:Type: Integer
2929
:Default: ``80``
@@ -34,7 +34,7 @@ Options
3434
:Description: Sets the listening address in the form ``address[:port]``, where
3535
the address is an IPv4 address string in dotted decimal form, or
3636
an IPv6 address in hexadecimal notation surrounded by square
37-
brackets. Specifying a IPv6 endpoint would listen to v6 only. The
37+
brackets. Specifying a IPv6 endpoint would listen to IPv6 only. The
3838
optional port defaults to 80 for ``endpoint`` and 443 for
3939
``ssl_endpoint``. Can be specified multiple times as in
4040
``endpoint=[::1] endpoint=192.168.0.100:8000``.
@@ -47,7 +47,7 @@ Options
4747

4848
:Description: Path to the SSL certificate file used for SSL-enabled endpoints.
4949
If path is prefixed with ``config://``, the certificate will be
50-
pulled from the ceph monitor ``config-key`` database.
50+
pulled from the Ceph Monitor ``config-key`` database.
5151

5252
:Type: String
5353
:Default: None
@@ -59,14 +59,14 @@ Options
5959
endpoints. If one is not given, the ``ssl_certificate`` file
6060
is used as the private key.
6161
If path is prefixed with ``config://``, the certificate will be
62-
pulled from the ceph monitor ``config-key`` database.
62+
pulled from the Ceph Monitor ``config-key`` database.
6363

6464
:Type: String
6565
:Default: None
6666

6767
``ssl_options``
6868

69-
:Description: Optional colon separated list of ssl context options:
69+
:Description: Optional colon separated list of SSL context options:
7070

7171
``default_workarounds`` Implement various bug workarounds.
7272

@@ -102,12 +102,12 @@ Options
102102
the connection which means that packets will be sent as soon
103103
as possible instead of waiting for a full buffer or timeout to occur.
104104

105-
``1`` Disable Nagel's algorithm for all sockets.
105+
``1`` Disable Nagle's algorithm for all sockets.
106106

107-
``0`` Keep the default: Nagel's algorithm enabled.
107+
``0`` Keep the default: Nagle's algorithm enabled.
108108

109109
:Type: Integer (0 or 1)
110-
:Default: 0
110+
:Default: ``0``
111111

112112
``max_connection_backlog``
113113

@@ -120,9 +120,9 @@ Options
120120

121121
``request_timeout_ms``
122122

123-
:Description: The amount of time in milliseconds that Beast will wait
123+
:Description: The amount of time in milliseconds that ``beast`` will wait
124124
for more incoming data or outgoing data before giving up.
125-
Setting this value to 0 will disable timeout.
125+
Setting this value to ``0`` will disable timeout.
126126

127127
:Type: Integer
128128
:Default: ``65000``
@@ -144,7 +144,7 @@ Options
144144
``0`` Disallow running multiple RGW on same port.
145145

146146
:Type: Integer (0 or 1)
147-
:Default: 0
147+
:Default: ``0``
148148

149149

150150
Generic Options
@@ -156,7 +156,7 @@ Some frontend options are generic and supported by all frontends:
156156

157157
:Description: A prefix string that is inserted into the URI of all
158158
requests. For example, a swift-only frontend could supply
159-
a uri prefix of ``/swift``.
159+
a URI prefix of ``/swift``.
160160

161161
:Type: String
162162
:Default: None

0 commit comments

Comments
 (0)