Repository: fujiapple852/trippy
Pull request #1459 (2024-12-26 14:59:04)

Spelling
This PR corrects misspellings identified by the [check-spelling action](https://github.com/marketplace/actions/check-spelling)

The misspellings have been reported at https://github.com/jsoref/trippy/actions/runs/12505245426#summary-34888305694

The action reports that the changes in this PR would make it happy: https://github.com/jsoref/trippy/actions/runs/12505245525#summary-34888305851

jsoref: The grammar is just a series of rules I add as I run into people making mistakes, it isn't core to the engine, it just takes advantage of a feature.
fujiapple852: Thanks @jsoref !

If you can squash the 14x spelling fixes into a single `docs: ...` commit and rename `link: step-by-step guide to manually configure the Windows Defender firewall rule` as `docs: ` it should be good to merge.

Patch:
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index aa8a84e..7fc5435 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -24,10 +24,10 @@ assignees: ''
 
 **Environment Info**
 
-- OS: <!-- e.g. Linux, Windows 11, MacOS -->
+- OS: <!-- e.g. Linux, Windows 11, macOS -->
 - Trippy version: <!-- the output of `trip -V` -->
 - Installation method: <!-- e.g. `brew`, `winget`, `cargo` -->
-- Terminal / Console: <!-- If you are not sure you can use "About" or, "Help" on the terminal window to gather the requested information. e.g. `iterm2`, `cmd.exe`, `PowerShell`, 'GNOME Terminal' -->
+- Terminal / Console: <!-- If you are not sure you can use "About" or, "Help" on the terminal window to gather the requested information. e.g. `iTerm2`, `cmd.exe`, `PowerShell`, 'GNOME Terminal' -->
 
 **Additional context**
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ccb545a..7074eae 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -350,7 +350,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Fixed
 
-- Local Ipv4 discovery fails on some platforms ([#133](https://github.com/fujiapple852/trippy/issues/133),
+- Local IPv4 discovery fails on some platforms ([#133](https://github.com/fujiapple852/trippy/issues/133),
   [#142](https://github.com/fujiapple852/trippy/issues/142))
 - DNS resolution not filtering for `IPv4` addresses ([#148](https://github.com/fujiapple852/trippy/issues/148))
   - Note: see [#35](https://github.com/fujiapple852/trippy/issues/35) for the status of `IPv6` support
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6996fee..35f0848 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -165,7 +165,7 @@ maintainers:
 - Crates.io
 - Docker
 - Snapcraft
-- Winget
+- WinGet
 - Ubuntu PPA
 
 ### Prerequisites
@@ -191,7 +191,7 @@ maintainers:
 Trippy is tested extensively in CI on Linux, Windows and macOS for every pull request. However, it is recommended to
 test the release binaries on all platforms before release.
 
-### Github Releases
+### GitHub Releases
 
 - Tag the release with the version number `0.xx.0` and push the tag to GitHub:
 
@@ -233,7 +233,7 @@ docker push fujiapple/trippy:latest
 - Promote the first `0.xx.0` build to the `latest/stable` channel from the
   Snapcraft [releases](https://snapcraft.io/trippy/releases) page
 
-### Winget
+### WinGet
 
 - Download the latest release Windows `zip` from
   the [GitHub releases page](https://github.com/fujiapple852/trippy/releases/latest)
diff --git a/RELEASES.md b/RELEASES.md
index 6d784bb..7724e29 100644
--- a/RELEASES.md
+++ b/RELEASES.md
@@ -315,7 +315,7 @@ The previous release of Trippy introduced a bug ([#1290](https://github.com/fuji
 caused reverse DNS lookups to be enqueued multiple times when the `dns-ttl` expired, potentially leading to the hostname
 being displayed as `Timeout: xxx` for a brief period.
 
-A long standing bug ([#1398](https://github.com/fujiapple852/trippy/issues/1398)) which caused the TUI sample history
+A long-standing bug ([#1398](https://github.com/fujiapple852/trippy/issues/1398)) which caused the TUI sample history
 and frequency charts to ignore sub-millisecond samples has been fixed.
 
 This release fixes a bug ([#1287](https://github.com/fujiapple852/trippy/issues/1287)) that caused the tracer to panic
@@ -993,7 +993,7 @@ more. Additionally, this release includes several important bug fixes along with
 
 ### Tracing Flows
 
-#### Flow Id
+#### Flow ID
 
 A tracing flow represents the sequence of hosts traversed from the source to the target. Trippy is now able to identify
 individual flows within a trace and assign each a unique flow id. Trippy calculate a flow id for each round of tracing,
@@ -1126,7 +1126,7 @@ The following screenshot shows ICMP extensions in hop detail mode:
 
 #### ICMP Extensions in Reports
 
-ICMP extension information is also included the the `json` and `stream` report modes.
+ICMP extension information is also included the `json` and `stream` report modes.
 
 Sample output for a single hop from the `json` report:
 
diff --git a/crates/trippy-core/src/flows.rs b/crates/trippy-core/src/flows.rs
index 9b7d077..1da1fbd 100644
--- a/crates/trippy-core/src/flows.rs
+++ b/crates/trippy-core/src/flows.rs
@@ -112,7 +112,7 @@ impl Flow {
     /// Check if a given `Flow` matches this `Flow`.
     ///
     /// Two flows are said to match _unless_ they contain different IP
-    /// addresses for the _same_ position (i.e. the `tll`).
+    /// addresses for the _same_ position (i.e. the same `ttl`).
     ///
     /// This is true even for flows of differing lengths.
     ///
diff --git a/crates/trippy-core/src/strategy.rs b/crates/trippy-core/src/strategy.rs
index f6deb58..e42d76d 100644
--- a/crates/trippy-core/src/strategy.rs
+++ b/crates/trippy-core/src/strategy.rs
@@ -1191,7 +1191,7 @@ mod state {
             self.buffer[usize::from(resp.sequence - self.round_sequence)] =
                 ProbeStatus::Complete(completed);
 
-            // If this `ProbeStatus` found the target then we set the `target_tll` if not already
+            // If this `ProbeStatus` found the target then we set the `target_ttl` if not already
             // set, being careful to account for `Probes` being received out-of-order.
             //
             // If this `ProbeStatus` did not find the target but has a ttl that is greater or equal
diff --git a/crates/trippy-packet/src/icmp_extension.rs b/crates/trippy-packet/src/icmp_extension.rs
index db3b053..9d4cbee 100644
--- a/crates/trippy-packet/src/icmp_extension.rs
+++ b/crates/trippy-packet/src/icmp_extension.rs
@@ -1270,7 +1270,7 @@ pub mod extension_splitter {
                 assert!(mpls_stack_member_iter.next().is_none());
             }
 
-            // Real Ipv6 example with a rfc4884 length of 16 (16 * 8 = 128
+            // Real IPv6 example with a rfc4884 length of 16 (16 * 8 = 128
             // octets for) but the total payload is only 84 octets and
             // therefore this is a malformed packet.
             //
diff --git a/crates/trippy-tui/src/config.rs b/crates/trippy-tui/src/config.rs
index f76041a..dc20226 100644
--- a/crates/trippy-tui/src/config.rs
+++ b/crates/trippy-tui/src/config.rs
@@ -1286,7 +1286,7 @@ mod tests {
     #[test_case("trip example.com -t 5", Ok(cfg().max_ttl(5).build()); "custom max ttl short")]
     #[test_case("trip example.com --max-ttl 0", Err(anyhow!("max-ttl (0) must be in the range 1..254")); "invalid low max ttl")]
     #[test_case("trip example.com --max-ttl 500", Err(anyhow!("error: invalid value '500' for '--max-ttl <MAX_TTL>': 500 is not in 0..=255 For more information, try '--help'.")); "invalid high max ttl")]
-    #[test_case("trip example.com --first-ttl 3 --max-ttl 2", Err(anyhow!("first-ttl (3) must be less than or equal to max-ttl (2)")); "first ttl higher than max ttl")]
+    #[test_case("trip example.com --first-ttl 3 --max-ttl 2", Err(anyhow!("first-ttl (3) must be less than or equal to max-ttl (2)")); "first ttl greater than max ttl")]
     #[test_case("trip example.com --first-ttl 5 --max-ttl 5", Ok(cfg().first_ttl(5).max_ttl(5).build()); "custom first and max ttl")]
     fn test_ttl(cmd: &str, expected: anyhow::Result<TrippyConfig>) {
         compare(parse_config(cmd), expected);
diff --git a/docs/src/content/docs/guides/windows_firewall.md b/docs/src/content/docs/guides/windows_firewall.md
index 7448a9b..fa5b87d 100644
--- a/docs/src/content/docs/guides/windows_firewall.md
+++ b/docs/src/content/docs/guides/windows_firewall.md
@@ -26,5 +26,4 @@ Disable-NetFirewallRule ICMPv4_TRIPPY_ALLOW
 Disable-NetFirewallRule ICMPv6_TRIPPY_ALLOW
 ```
 
-The Windows Defender firewall rule may also be configured manually,
-see [here](https://github.com/fujiapple852/trippy/issues/578#issuecomment-1565149826) for a step-by-step guide.
+There is a [step-by-step guide to manually configure the Windows Defender firewall rule](https://github.com/fujiapple852/trippy/issues/578#issuecomment-1565149826).
diff --git a/docs/src/content/docs/reference/cli.md b/docs/src/content/docs/reference/cli.md
index cc3f13a..b75e846 100644
--- a/docs/src/content/docs/reference/cli.md
+++ b/docs/src/content/docs/reference/cli.md
@@ -57,10 +57,10 @@ Options:
           The address family [default: Ipv4thenIpv6]
 
           Possible values:
-          - ipv4:           Ipv4 only
-          - ipv6:           Ipv6 only
-          - ipv6-then-ipv4: Ipv6 with a fallback to Ipv4
-          - ipv4-then-ipv6: Ipv4 with a fallback to Ipv6
+          - ipv4:           IPv4 only
+          - ipv6:           IPv6 only
+          - ipv6-then-ipv4: IPv6 with a fallback to IPv4
+          - ipv4-then-ipv6: IPv4 with a fallback to IPv6
 
   -4, --ipv4
           Use IPv4 only
diff --git a/docs/src/content/docs/reference/version.md b/docs/src/content/docs/reference/version.md
index dbb0ef7..9fbc5bb 100644
--- a/docs/src/content/docs/reference/version.md
+++ b/docs/src/content/docs/reference/version.md
@@ -5,7 +5,7 @@ sidebar:
   order: 7
 ---
 
-The following table lists ths versions of Trippy that are available and links to the corresponding release note and
+The following table lists this versions of Trippy that are available and links to the corresponding release note and
 documentation:
 
 | Version    | Release Date | Status      | Release Note                                                       | Documentation                                              |
diff --git a/examples/traceroute/src/main.rs b/examples/traceroute/src/main.rs
index e50d580..74ac18d 100644
--- a/examples/traceroute/src/main.rs
+++ b/examples/traceroute/src/main.rs
@@ -48,7 +48,7 @@ fn main() -> anyhow::Result<()> {
     let max_ttl = args.max_ttl.unwrap_or(64);
     let nqueries = args.nqueries.unwrap_or(3);
     let tos = args.tos.unwrap_or(0);
-    let pausemecs = args.pausemsecs.unwrap_or(100);
+    let pausemsecs = args.pausemsecs.unwrap_or(100);
     let port_direction = if args.evasion {
         PortDirection::new_fixed_dest(port)
     } else {
@@ -79,8 +79,8 @@ fn main() -> anyhow::Result<()> {
         .tos(tos)
         .max_flows(1)
         .max_rounds(Some(nqueries))
-        .min_round_duration(Duration::from_millis(pausemecs))
-        .max_round_duration(Duration::from_millis(pausemecs))
+        .min_round_duration(Duration::from_millis(pausemsecs))
+        .max_round_duration(Duration::from_millis(pausemsecs))
         .build()?;
     println!(
         "traceroute to {} ({}), {} hops max, {} byte packets",
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
index 2535c0a..8b37d41 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -58,7 +58,7 @@ description: |
     - `network`: to allow general outgoing network access
     - `network-bind`: to allow binding to local ports
     - `network-observe`: to allow enabling `CAP_NET_RAW` for using raw sockets
-    - `home`: to allow access to /home for reading the configuraton file
+    - `home`: to allow access to /home for reading the configuration file
 contact: mailto:fujiapple852@gmail.com
 issues: https://github.com/fujiapple852/trippy/issues
 license: Apache-2.0
diff --git a/trippy-config-sample.toml b/trippy-config-sample.toml
index 5b4eeb3..b30678a 100644
--- a/trippy-config-sample.toml
+++ b/trippy-config-sample.toml
@@ -77,10 +77,10 @@ protocol = "icmp"
 # The address family.
 #
 # Allowed values are:
-#   ipv4            - Lookup Ipv4 only
-#   ipv6            - Lookup Ipv6 only
-#   ipv6-then-ipv4  - Lookup Ipv6 with a fallback to Ipv4
-#   ipv4-then-ipv6  - Lookup Ipv4 with a fallback to Ipv6 [default]
+#   ipv4            - Lookup IPv4 only
+#   ipv6            - Lookup IPv6 only
+#   ipv6-then-ipv4  - Lookup IPv6 with a fallback to IPv4
+#   ipv4-then-ipv6  - Lookup IPv4 with a fallback to IPv6 [default]
 addr-family = "ipv4-then-ipv6"
 
 # The target port (TCP & UDP only) [default: 80]


Test patch:
diff --git a/crates/trippy-core/tests/resources/simulation/ipv4_icmp_quick.toml b/crates/trippy-core/tests/resources/simulation/ipv4_icmp_quick.toml
index 72261bb..981e7ea 100644
--- a/crates/trippy-core/tests/resources/simulation/ipv4_icmp_quick.toml
+++ b/crates/trippy-core/tests/resources/simulation/ipv4_icmp_quick.toml
@@ -1,4 +1,4 @@
-name = "IPv4/ICMP wih min/max round duration 250ms and grace 50ms"
+name = "IPv4/ICMP with min/max round duration 250ms and grace 50ms"
 target = "10.0.0.110"
 protocol = "Icmp"
 icmp_identifier = 7