From 1eca514c6bc89f9359c3a1e2214e71d55d4700c1 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Wed, 9 Dec 2020 11:33:49 -0500 Subject: [PATCH] API doc: use minus sign (U+2212) where appropriate instead of `-` MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit The minus sign is usually rendered larger than `-` and therefore visually more interesting for mathematical expressions. Signed-off-by: Philippe Proulx Change-Id: I9f9dc8cde4ecce1b40e9fb08ac2e188221fffe3b Reviewed-on: https://review.lttng.org/c/babeltrace/+/4527 Tested-by: jenkins Reviewed-by: Jérémie Galarneau --- include/babeltrace2/graph/message.h | 2 +- include/babeltrace2/integer-range-set.h | 4 ++-- include/babeltrace2/trace-ir/clock-class.h | 6 +++--- include/babeltrace2/trace-ir/field-class.h | 16 ++++++++-------- include/babeltrace2/util.h | 6 +++--- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/include/babeltrace2/graph/message.h b/include/babeltrace2/graph/message.h index 27730f69..c5a75bda 100644 --- a/include/babeltrace2/graph/message.h +++ b/include/babeltrace2/graph/message.h @@ -804,7 +804,7 @@ For example: - The maximum \ref api-tir-fc-int-prop-size "field value range" for an \bt_uint_fc - is [0, 264 - 1]. + is [0, 264 âˆ’ 1]. - The available message types are stream beginning and end, event, packet beginning and end, discarded events and packets, and message diff --git a/include/babeltrace2/integer-range-set.h b/include/babeltrace2/integer-range-set.h index 86b0dc46..7e87fe9d 100644 --- a/include/babeltrace2/integer-range-set.h +++ b/include/babeltrace2/integer-range-set.h @@ -624,8 +624,8 @@ bt_integer_range_set_signed_borrow_range_by_index_const( Two signed integer range sets are considered equal if they contain the exact same signed integer ranges, whatever the order. In other words, -a signed integer range set containing [-57, 23] and [24, 42] -is \em not equal to a signed integer range containing [-57, 42]. +a signed integer range set containing [−57, 23] and [24, 42] +is \em not equal to a signed integer range containing [−57, 42]. @param[in] int_range_set_a Signed integer range set A. diff --git a/include/babeltrace2/trace-ir/clock-class.h b/include/babeltrace2/trace-ir/clock-class.h index d9f77b8b..b28a6c5e 100644 --- a/include/babeltrace2/trace-ir/clock-class.h +++ b/include/babeltrace2/trace-ir/clock-class.h @@ -147,12 +147,12 @@ The clock class's "offset in seconds" property can be negative. For example, considering: - Frequency: 1000 Hz. -- Offset in seconds: -10 seconds. +- Offset in seconds: −10 seconds. - Offset in cycles: 500 cycles (that is, 0.5 seconds). - Stream clock's value: 2000 cycles (that is, 2 seconds). -Then the computed value is -7.5 seconds from origin, or --7,500,000,000 nanoseconds from origin. +Then the computed value is −7.5 seconds from origin, or +−7,500,000,000 nanoseconds from origin.

Properties

diff --git a/include/babeltrace2/trace-ir/field-class.h b/include/babeltrace2/trace-ir/field-class.h index d8b49a3e..4d862482 100644 --- a/include/babeltrace2/trace-ir/field-class.h +++ b/include/babeltrace2/trace-ir/field-class.h @@ -1726,10 +1726,10 @@ See the \ref api-tir-fc-int-prop-size "field value range" property.
Unsigned integer field class
-
[0, 2N - 1]
+
[0, 2N âˆ’ 1]
Signed integer field class
-
[-2N - 1, 2N - 1 - 1]
+
[−2N âˆ’ 1, 2N âˆ’ 1 âˆ’ 1]
@endparblock @@ -1760,10 +1760,10 @@ See the \ref api-tir-fc-int-prop-size "field value range" property.
Unsigned integer field class
-
[0, 2N - 1]
+
[0, 2N âˆ’ 1]
Signed integer field class
-
[-2N, 2N - 1]
+
[−2N, 2N âˆ’ 1]
@endparblock @@ -1879,7 +1879,7 @@ property values: Value \ref api-tir-fc-int-prop-size "Field value range" - [0, 264 - 1] + [0, 264 âˆ’ 1] \ref api-tir-fc-int-prop-base "Preferred display base" #BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL @@ -1919,7 +1919,7 @@ property values: Value \ref api-tir-fc-int-prop-size "Field value range" - [-263, 263 - 1] + [−263, 263 âˆ’ 1] \ref api-tir-fc-int-prop-base "Preferred display base" #BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL @@ -2144,7 +2144,7 @@ following property values: Value \ref api-tir-fc-int-prop-size "Field value range" - [0, 264 - 1] + [0, 264 âˆ’ 1] \ref api-tir-fc-int-prop-base "Preferred display base" #BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL @@ -2409,7 +2409,7 @@ following property values: Value \ref api-tir-fc-int-prop-size "Field value range" - [-263, 263 - 1] + [−263, 263 âˆ’ 1] \ref api-tir-fc-int-prop-base "Preferred display base" #BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL diff --git a/include/babeltrace2/util.h b/include/babeltrace2/util.h index 1c37b8e3..8426a0ad 100644 --- a/include/babeltrace2/util.h +++ b/include/babeltrace2/util.h @@ -73,13 +73,13 @@ The following illustration shows the possible scenarios: \bt_p{offset_seconds} can be negative. For example, considering: - A 1000 Hz clock. -- \bt_p{offset_seconds} set to -10 seconds. +- \bt_p{offset_seconds} set to −10 seconds. - \bt_p{offset_cycles} set to 500 cycles (that is, 0.5 seconds). - \bt_p{cycles} set to 2000 cycles (that is, 2 seconds). -The computed value is -7.5 seconds, so this function sets -\bt_p{*ns_from_origin} to -7,500,000,000. +The computed value is −7.5 seconds, so this function sets +\bt_p{*ns_from_origin} to −7,500,000,000. This function can fail and return the #BT_UTIL_CLOCK_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW_ERROR status -- 2.34.1