From 53f9e5a357c7bc30b01c738d325b4f4a9acc32a6 Mon Sep 17 00:00:00 2001
From: "M.Amin Rayej" <m.amin.rayej@gmail.com>
Date: Wed, 31 Jan 2024 16:11:54 +0330
Subject: [PATCH] ci: make sure dictionary words are sorted and unique (#6316)

---
 .github/workflows/ci.yml | 13 +++++++++++++
 spellcheck.dic           | 40 ++++++++++++++++++++--------------------
 2 files changed, 33 insertions(+), 20 deletions(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index c0e728e63b0..44cf3f6cd52 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -1011,6 +1011,19 @@ jobs:
         with:
           tool: cargo-spellcheck
       - uses: actions/checkout@v4
+      - name: Make sure dictionary words are sorted and unique
+        run: |
+          # `sed` removes the first line (number of words) and
+          # the last line (new line). 
+          # 
+          # `sort` makes sure everything in between is sorted
+          # and contains no duplicates.
+          # 
+          # Since `sort` is sensitive to locale, we set it
+          # using LC_ALL to en_US.UTF8 to be consistent in different
+          # environments.
+
+          sed '1d; $d' spellcheck.dic | LC_ALL=en_US.UTF8 sort -uc
       - name: Run cargo-spellcheck
         run: cargo spellcheck --code 1
 
diff --git a/spellcheck.dic b/spellcheck.dic
index ddedb90730d..ea73532afc1 100644
--- a/spellcheck.dic
+++ b/spellcheck.dic
@@ -1,30 +1,30 @@
 279
+&
++
+<
+=
+>
 \
 ~
-~4
-~12
-±1m
-±1ms
 —
-&
-+
 0o777
 0s
 0xA
 0xD
 100ms
 10ms
+~12
+±1m
+±1ms
 1ms
 1s
 250ms
 2x
+~4
 443
 450ms
 50ms
 8MB
-<
-=
->
 adaptor
 adaptors
 Adaptors
@@ -56,14 +56,14 @@ codec
 codecs
 combinator
 combinators
-Config
 config
+Config
 connectionless
 cpu
 cpus
 Customizable
-Datagram
 datagram
+Datagram
 datagrams
 deallocate
 deallocated
@@ -73,8 +73,8 @@ dequeued
 deregister
 deregistered
 deregistering
-Deregisters
 deregisters
+Deregisters
 deregistration
 descriptor's
 destructor
@@ -122,8 +122,8 @@ implementor
 implementors
 incrementing
 interoperate
-Invariants
 invariants
+Invariants
 io
 IOCP
 iOS
@@ -149,8 +149,8 @@ misconfigured
 mock's
 mpmc
 mpsc
-Multi
 multi
+Multi
 multicast
 Multithreaded
 mut
@@ -191,8 +191,8 @@ resize
 resized
 RMW
 runtime
-runtimes
 runtime's
+runtimes
 rwlock
 rx
 scalability
@@ -229,8 +229,8 @@ symlinks
 sys
 syscall
 syscalls
-TCP
 tcp
+TCP
 TestU01
 threadpool
 timestamp
@@ -238,15 +238,15 @@ timestamps
 TLS
 TOCTOU
 TODO
-Tokio
 tokio
+Tokio
 tokio's
 Tokio's
-Tuple
 tuple
+Tuple
 tx
-UDP
 udp
+UDP
 UID
 unhandled
 unix
@@ -255,8 +255,8 @@ unpark
 Unpark
 unparked
 unparking
-Unparks
 unparks
+Unparks
 unreceived
 unsafety
 Unsets