Skip to content

Commit 57181bf

Browse files
authored
Change highwater -> high water, add mutexes to spelling wordlist [AP-650] (#1413)
# Description @swift-nav/devinfra - Change `highwater` -> `high water` in documentation for profiling message - Add `mutexes` to spelling wordlist # API compatibility Does this change introduce a API compatibility risk? No ## API compatibility plan If the above is "Yes", please detail the compatibility (or migration) plan: No # JIRA Reference https://swift-nav.atlassian.net/browse/AP-650
1 parent 7da3bf7 commit 57181bf

File tree

9 files changed

+9
-8
lines changed

9 files changed

+9
-8
lines changed

c/include/libsbp/profiling/MSG_PROFILING_THREAD_INFO.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ typedef struct {
6666
u32 stack_size;
6767

6868
/**
69-
* Stack highwater usage in bytes
69+
* Stack high water usage in bytes
7070
*/
7171
u32 stack_usage;
7272

haskell/src/SwiftNav/SBP/Profiling.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ data MsgProfilingThreadInfo = MsgProfilingThreadInfo
148148
, _msgProfilingThreadInfo_stack_size :: !Word32
149149
-- ^ Stack size in bytes
150150
, _msgProfilingThreadInfo_stack_usage :: !Word32
151-
-- ^ Stack highwater usage in bytes
151+
-- ^ Stack high water usage in bytes
152152
, _msgProfilingThreadInfo_name :: !Text
153153
-- ^ Thread name
154154
} deriving ( Show, Read, Eq )

java/src/com/swiftnav/sbp/profiling/MsgProfilingThreadInfo.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public class MsgProfilingThreadInfo extends SBPMessage {
4343
/** Stack size in bytes */
4444
public long stack_size;
4545

46-
/** Stack highwater usage in bytes */
46+
/** Stack high water usage in bytes */
4747
public long stack_usage;
4848

4949
/** Thread name */

javascript/sbp/profiling.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ MsgProfilingSystemInfo.prototype.fieldSpec.push(['heap_usage', 'writeUInt32LE',
127127
* @field age number (unsigned 64-bit int, 8 bytes) Age of the thread in microseconds
128128
* @field state number (unsigned 8-bit int, 1 byte) Thread state
129129
* @field stack_size number (unsigned 32-bit int, 4 bytes) Stack size in bytes
130-
* @field stack_usage number (unsigned 32-bit int, 4 bytes) Stack highwater usage in bytes
130+
* @field stack_usage number (unsigned 32-bit int, 4 bytes) Stack high water usage in bytes
131131
* @field name string Thread name
132132
*
133133
* @param sbp An SBP object with a payload to be decoded.

kaitai/ksy/profiling.ksy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ types:
113113
type: u4
114114
- id: stack_usage
115115
doc: |
116-
Stack highwater usage in bytes
116+
Stack high water usage in bytes
117117
type: u4
118118
- id: name
119119
doc: |

python/docs/source/spelling_wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ lon
100100
mesid
101101
msg
102102
msgs
103+
mutexes
103104
nd
104105
ndb
105106
netlink

python/sbp/profiling.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ class MsgProfilingThreadInfo(SBP):
374374
stack_size : int
375375
Stack size in bytes
376376
stack_usage : int
377-
Stack highwater usage in bytes
377+
Stack high water usage in bytes
378378
name : string
379379
Thread name
380380
sender : int

rust/sbp/src/messages/profiling.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ pub mod msg_profiling_thread_info {
399399
/// Stack size in bytes
400400
#[cfg_attr(feature = "serde", serde(rename = "stack_size"))]
401401
pub stack_size: u32,
402-
/// Stack highwater usage in bytes
402+
/// Stack high water usage in bytes
403403
#[cfg_attr(feature = "serde", serde(rename = "stack_usage"))]
404404
pub stack_usage: u32,
405405
/// Thread name

spec/yaml/swiftnav/sbp/profiling.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ definitions:
105105
desc: Stack size in bytes
106106
- stack_usage:
107107
type: u32
108-
desc: Stack highwater usage in bytes
108+
desc: Stack high water usage in bytes
109109
- name:
110110
type: string
111111
encoding: null_terminated

0 commit comments

Comments
 (0)