Skip to content

Commit 55b3adb

Browse files
authored
[docs] fix double 'the' typos across the codebase (openthread#13176)
This commit fixes instances of "the the" typos found in various files across the codebase, including documentation, headers, source files, and test scripts.
1 parent e4df5dd commit 55b3adb

23 files changed

Lines changed: 30 additions & 31 deletions

File tree

include/openthread/instance.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ extern "C" {
5252
*
5353
* @note This number versions both OpenThread platform and user APIs.
5454
*/
55-
#define OPENTHREAD_API_VERSION (600)
55+
#define OPENTHREAD_API_VERSION (601)
5656

5757
/**
5858
* @addtogroup api-instance

include/openthread/message.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ void otMessageSetLoopbackToHostAllowed(otMessage *aMessage, bool aAllowLoopbackT
234234
* Indicates whether the given message may be looped back in a case of a multicast destination address.
235235
*
236236
* If @p aMessage is used along with an `otMessageInfo`, the `mMulticastLoop` field from `otMessageInfo` structure
237-
* takes precedence and will be used instead of the the value set on @p aMessage.
237+
* takes precedence and will be used instead of the value set on @p aMessage.
238238
*
239239
* This API is mainly intended for use along with `otIp6Send()` which expects an already prepared IPv6 message.
240240
*

include/openthread/platform/dso_transport.h

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,7 @@ extern "C" {
5353
typedef struct otPlatDsoConnection otPlatDsoConnection;
5454

5555
/**
56-
* Can be used by DSO platform implementation to get the the OpenThread instance associated with a
57-
* connection instance.
56+
* Can be used by DSO platform implementation to get the OpenThread instance associated with a connection instance.
5857
*
5958
* @param[in] aConnection A pointer to the DSO connection.
6059
*
@@ -124,7 +123,7 @@ extern void otPlatDsoHandleConnected(otPlatDsoConnection *aConnection);
124123
* Passes the ownership of the @p aMessage to the DSO platform layer, and the platform implementation is
125124
* expected to free the message once it is no longer needed.
126125
*
127-
* The @p aMessage contains the DNS message (starting with DNS header). Note that it does not contain the the length
126+
* The @p aMessage contains the DNS message (starting with DNS header). Note that it does not contain the length
128127
* field that is needed when sending over TLS/TCP transport. The platform layer MUST therefore include the length
129128
* field when passing the message to TLS/TCP layer.
130129
*

include/openthread/platform/radio.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ typedef struct otRadioFrame
359359
* If `mIsHeaderUpdated` is not set, then the frame counter and key CSL IE not set in the frame by
360360
* OpenThread core and it is the responsibility of the radio platform to assign them. The platform
361361
* must update the frame header (assign counter and CSL IE values) before sending the frame over the air,
362-
* however if the the transmission gets aborted and the frame is never sent over the air (e.g., channel
362+
* however if the transmission gets aborted and the frame is never sent over the air (e.g., channel
363363
* access error) the platform may choose to not update the header. If the platform updates the header,
364364
* it must also set this flag before passing the frame back from the `otPlatRadioTxDone()` callback.
365365
*/

script/check-size

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ build_nrf52840()
125125
git archive "${sha}" | tar x -C "${OT_TMP_DIR}/${folder}/openthread"
126126

127127
if [ ! -e "${OT_TMP_DIR}/${folder}/openthread/examples/config/${config_name}" ]; then
128-
# Check if the the config headers are not present, copy from
128+
# Check if the config headers are not present, copy from
129129
# the main sha.
130130
case "$1" in
131131
br)

src/cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2556,7 +2556,7 @@ Locate the closest destination of an anycast address (i.e., find the destination
25562556

25572557
`OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE` is required.
25582558

2559-
The closest destination is determined based on the the current routing table and path costs within the Thread mesh.
2559+
The closest destination is determined based on the current routing table and path costs within the Thread mesh.
25602560

25612561
Locate the leader using its anycast address:
25622562

src/core/common/log.hpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ constexpr uint16_t kMaxLogStringSize = OPENTHREAD_CONFIG_LOG_MAX_SIZE; ///< Max
112112
/**
113113
* Emits an error log message at critical log level if there is an error.
114114
*
115-
* The emitted log will use the the following format "Failed to {aFormattedText} - {ErrorToString(aError)}", and will
115+
* The emitted log will use the following format "Failed to {aFormattedText} - {ErrorToString(aError)}", and will
116116
* be emitted only if there is an error, i.e., @p aError is not `kErrorNone`.
117117
*
118118
* @param[in] aError The error to check and log.
@@ -135,7 +135,7 @@ constexpr uint16_t kMaxLogStringSize = OPENTHREAD_CONFIG_LOG_MAX_SIZE; ///< Max
135135
/**
136136
* Emits an error log message at warning log level if there is an error.
137137
*
138-
* The emitted log will use the the following format "Failed to {aFormattedText} - {ErrorToString(aError)}", and will
138+
* The emitted log will use the following format "Failed to {aFormattedText} - {ErrorToString(aError)}", and will
139139
* be emitted only if there is an error, i.e., @p aError is not `kErrorNone`.
140140
*
141141
* @param[in] aError The error to check and log.
@@ -159,7 +159,7 @@ constexpr uint16_t kMaxLogStringSize = OPENTHREAD_CONFIG_LOG_MAX_SIZE; ///< Max
159159
/**
160160
* Emits an error log message at note log level if there is an error.
161161
*
162-
* The emitted log will use the the following format "Failed to {aFormattedText} - {ErrorToString(aError)}", and will
162+
* The emitted log will use the following format "Failed to {aFormattedText} - {ErrorToString(aError)}", and will
163163
* be emitted only if there is an error, i.e., @p aError is not `kErrorNone`.
164164
*
165165
* @param[in] aError The error to check and log.
@@ -183,7 +183,7 @@ constexpr uint16_t kMaxLogStringSize = OPENTHREAD_CONFIG_LOG_MAX_SIZE; ///< Max
183183
/**
184184
* Emits an error log message at info log level if there is an error.
185185
*
186-
* The emitted log will use the the following format "Failed to {aFormattedText} - {ErrorToString(aError)}", and will
186+
* The emitted log will use the following format "Failed to {aFormattedText} - {ErrorToString(aError)}", and will
187187
* be emitted only if there is an error, i.e., @p aError is not `kErrorNone`.
188188
*
189189
* @param[in] aError The error to check and log.
@@ -207,7 +207,7 @@ constexpr uint16_t kMaxLogStringSize = OPENTHREAD_CONFIG_LOG_MAX_SIZE; ///< Max
207207
/**
208208
* Emits an error log message at debug log level if there is an error.
209209
*
210-
* The emitted log will use the the following format "Failed to {aFormattedText} - {ErrorToString(aError)}", and will
210+
* The emitted log will use the following format "Failed to {aFormattedText} - {ErrorToString(aError)}", and will
211211
* be emitted only if there is an error, i.e., @p aError is not `kErrorNone`.
212212
*
213213
* @param[in] aError The error to check and log.

src/core/common/settings.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -578,7 +578,7 @@ class SettingsBase : public InstanceLocator
578578
uint32_t GetLifetime(void) const { return mLifetime; }
579579

580580
/**
581-
* Sets the the prefix lifetime.
581+
* Sets the prefix lifetime.
582582
*
583583
* @param[in] aLifetime The prefix lifetime in seconds.
584584
*/

src/core/crypto/ecdsa.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ class P256
164164
*
165165
* Gives non-const pointer to the buffer and is intended for populating the buffer and setting
166166
* the key-pair (e.g., reading the key-pair from non-volatile settings). The buffer contains `kMaxDerSize`
167-
* bytes. After populating the buffer, `SetDerLength()` can be used to set the the number of bytes written.
167+
* bytes. After populating the buffer, `SetDerLength()` can be used to set the number of bytes written.
168168
*
169169
* @returns The pointer to the start of key-pair buffer in DER format.
170170
*/

src/core/instance/instance.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ class Instance : public otInstance, private NonCopyable
461461
#endif
462462

463463
/**
464-
* Retrieves the the Message Buffer information.
464+
* Retrieves the Message Buffer information.
465465
*
466466
* @param[out] aInfo A `BufferInfo` where information is written.
467467
*/

0 commit comments

Comments
 (0)