From: Kefu Chai Date: Sat, 17 Apr 2021 23:55:39 +0000 (+0800) Subject: doc/rados/configuration/ceph-conf: use "describe" to define option types X-Git-Tag: v17.1.0~2202^2~5 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=1ecd8e7f97b6bbdb699b2a01b57b9537942ac34e;p=ceph.git doc/rados/configuration/ceph-conf: use "describe" to define option types Signed-off-by: Kefu Chai --- diff --git a/doc/rados/configuration/ceph-conf.rst b/doc/rados/configuration/ceph-conf.rst index 813df3721f024..fc851d8f627ac 100644 --- a/doc/rados/configuration/ceph-conf.rst +++ b/doc/rados/configuration/ceph-conf.rst @@ -331,62 +331,70 @@ like Every configuration option is typed with one of the types below: -``int`` +.. describe:: int -:Description: 64-bit signed integer, Some SI prefixes are supported, like "K", "M", "G", - "T", "P", "E", meaning, respectively, 10\ :sup:`3`, 10\ :sup:`6`, - 10\ :sup:`9`, etc. And "B" is the only supported unit. So, "1K", "1M", "128B" and "-1" are all valid - option values. Some times, a negative value implies "unlimited" when it comes to - an option for threshold or limit. -:Example: ``42``, ``-1`` + 64-bit signed integer, Some SI prefixes are supported, like "K", "M", "G", + "T", "P", "E", meaning, respectively, 10\ :sup:`3`, 10\ :sup:`6`, + 10\ :sup:`9`, etc. And "B" is the only supported unit. So, "1K", "1M", "128B" and "-1" are all valid + option values. Some times, a negative value implies "unlimited" when it comes to + an option for threshold or limit. -``uint`` + :example: ``42``, ``-1`` -:Description: It is almost identical to ``integer``. But a negative value will be rejected. -:Example: ``256``, ``0`` +.. describe:: uint -``str`` + It is almost identical to ``integer``. But a negative value will be rejected. -:Description: Free style strings encoded in UTF-8, but some characters are not allowed. Please - reference the above notes for the details. -:Example: ``"hello world"``, ``"i love \#"``, ``yet-another-name`` + :example: ``256``, ``0`` -``boolean`` +.. describe:: str -:Description: one of the two values ``true`` or ``false``. But an integer is also accepted, - where "0" implies ``false``, and any non-zero values imply ``true``. -:Example: ``true``, ``false``, ``1``, ``0`` + Free style strings encoded in UTF-8, but some characters are not allowed. Please + reference the above notes for the details. -``addr`` + :example: ``"hello world"``, ``"i love \#"``, ``yet-another-name`` -:Description: a single address optionally prefixed with ``v1``, ``v2`` or ``any`` for the messenger - protocol. If the prefix is not specified, ``v2`` protocol is used. Please see - :ref:`address_formats` for more details. -:Example: ``v1:1.2.3.4:567``, ``v2:1.2.3.4:567``, ``1.2.3.4:567``, ``2409:8a1e:8fb6:aa20:1260:4bff:fe92:18f5::567``, ``[::1]:6789`` +.. describe:: boolean -``addrvec`` + one of the two values ``true`` or ``false``. But an integer is also accepted, + where "0" implies ``false``, and any non-zero values imply ``true``. -:Description: a set of addresses separated by ",". The addresses can be optionally quoted with ``[`` and ``]``. -:Example: ``[v1:1.2.3.4:567,v2:1.2.3.4:568]``, ``v1:1.2.3.4:567,v1:1.2.3.14:567`` ``[2409:8a1e:8fb6:aa20:1260:4bff:fe92:18f5::567], [2409:8a1e:8fb6:aa20:1260:4bff:fe92:18f5::568]`` + :example: ``true``, ``false``, ``1``, ``0`` -``uuid`` +.. describe:: addr -:Description: the string format of a uuid defined by `RFC4122 `_. - And some variants are also supported, for more details, see - `Boost document `_. -:Example: ``f81d4fae-7dec-11d0-a765-00a0c91e6bf6`` + a single address optionally prefixed with ``v1``, ``v2`` or ``any`` for the messenger + protocol. If the prefix is not specified, ``v2`` protocol is used. Please see + :ref:`address_formats` for more details. -``size`` + :example: ``v1:1.2.3.4:567``, ``v2:1.2.3.4:567``, ``1.2.3.4:567``, ``2409:8a1e:8fb6:aa20:1260:4bff:fe92:18f5::567``, ``[::1]:6789`` -:Description: denotes a 64-bit unsigned integer. Both SI prefixes and IEC prefixes are - supported. And "B" is the only supported unit. A negative value will be - rejected. -:Example: ``1Ki``, ``1K``, ``1KiB`` and ``1B``. +.. describe:: addrvec -``secs`` + a set of addresses separated by ",". The addresses can be optionally quoted with ``[`` and ``]``. -:Description: denotes a duration of time. By default the unit is second if not specified. - Following units of time are supported: + :example: ``[v1:1.2.3.4:567,v2:1.2.3.4:568]``, ``v1:1.2.3.4:567,v1:1.2.3.14:567`` ``[2409:8a1e:8fb6:aa20:1260:4bff:fe92:18f5::567], [2409:8a1e:8fb6:aa20:1260:4bff:fe92:18f5::568]`` + +.. describe:: uuid + + the string format of a uuid defined by `RFC4122 `_. + And some variants are also supported, for more details, see + `Boost document `_. + + :example: ``f81d4fae-7dec-11d0-a765-00a0c91e6bf6`` + +.. describe:: size + + denotes a 64-bit unsigned integer. Both SI prefixes and IEC prefixes are + supported. And "B" is the only supported unit. A negative value will be + rejected. + + :example: ``1Ki``, ``1K``, ``1KiB`` and ``1B``. + +.. describe:: secs + + denotes a duration of time. By default the unit is second if not specified. + Following units of time are supported: * second: "s", "sec", "second", "seconds" * minute: "m", "min", "minute", "minutes" @@ -395,7 +403,8 @@ Every configuration option is typed with one of the types below: * week: "w", "wk", "week", "weeks" * month: "mo", "month", "months" * year: "y", "yr", "year", "years" -:Example: ``1 m``, ``1m`` and ``1 week`` + + :example: ``1 m``, ``1m`` and ``1 week`` .. _ceph-conf-database: