Add a textreview check (#436)

.gitattributes

@@ -0,0 +1,8 @@
+# All files are assumed to be reviewed in a printed form by default.
+* textreview
+# Binary files are not reviewed in printed form.
+*.pdf -textreview
+*.png -textreview
+*.wasm -textreview
+# Submodules are not reviewed in printed form.
+/third_party/** -textreview

.github/actions/ci-checks/action.yml

@@ -26,6 +26,9 @@ runs:
     - if: ${{ contains(fromJSON(inputs.checks), 'changelog') }}
       run: ./scripts/ci-changelog.sh
       shell: bash
+    - if: ${{ contains(fromJSON(inputs.checks), 'textreview') }}
+      run: cargo xtask textreview
+      shell: bash
     - if: ${{ contains(fromJSON(inputs.checks), 'sync') }}
       run: ./scripts/sync.sh
       shell: bash

.github/workflows/ci.yml

@@ -35,19 +35,20 @@ jobs:
             done
             true
           }
-          x  copyright  pull_request
-          x  changelog  pull_request
-          x       sync  pull_request  push  schedule
-          x    publish  pull_request  push  schedule
-          x      taplo  pull_request  push  schedule
-          x    applets  pull_request  push  schedule
-          x    runners  pull_request  push  schedule
-          x    tests-0  pull_request  push  schedule
-          x    tests-1  pull_request  push  schedule
-          x    tests-2  pull_request  push  schedule
-          x    hw-host  pull_request  push  schedule
-          x       book  pull_request  push  schedule
-          x  footprint  pull_request  push
+          x   copyright  pull_request
+          x   changelog  pull_request
+          x  textreview  pull_request
+          x        sync  pull_request  push  schedule
+          x     publish  pull_request  push  schedule
+          x       taplo  pull_request  push  schedule
+          x     applets  pull_request  push  schedule
+          x     runners  pull_request  push  schedule
+          x     tests-0  pull_request  push  schedule
+          x     tests-1  pull_request  push  schedule
+          x     tests-2  pull_request  push  schedule
+          x     hw-host  pull_request  push  schedule
+          x        book  pull_request  push  schedule
+          x   footprint  pull_request  push
           echo "checks=[$CHECKS]" >> $GITHUB_OUTPUT
     outputs:
       checks: ${{ steps.checks.outputs.checks }}

book/src/applet/run.md

@@ -56,8 +56,8 @@ After a bunch of compilation steps, you should see something that ends like:
 
 ```plaintext
 ".../wrapper.sh" "probe-rs" "run" "--chip=nRF52840_xxAA" "target/.../runner-nordic"
-     Erasing sectors ✔ [00:00:05] [################################]
- Programming pages   ✔ [00:00:04] [################################]
+     Erasing sectors [00:00:05] [################################]
+ Programming pages   [00:00:04] [################################]
 0.090527: hello world
 ```
 

crates/board/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Patch
 
+- Update dependencies
 - Document all public API
 
 ## 0.6.0

crates/board/Cargo.toml

@@ -38,7 +38,7 @@ usbd-serial = { version = "0.2.0", default-features = false }
 wasefire-applet-api = { version = "0.6.0", path = "../api", features = ["host"] }
 wasefire-error = { version = "0.1.0", path = "../error" }
 wasefire-logger = { version = "0.1.4", path = "../logger" }
-wasefire-store = { version = "0.2.3", path = "../store", optional = true }
+wasefire-store = { version = "0.2.4-git", path = "../store", optional = true }
 
 [features]
 std = ["wasefire-store?/std"]

crates/scheduler/CHANGELOG.md

@@ -124,4 +124,4 @@
 
 ## 0.1.0
 
-<!-- Increment to skip CHANGELOG.md test: 31 -->
+<!-- Increment to skip CHANGELOG.md test: 32 -->

crates/scheduler/Cargo.toml

@@ -27,7 +27,7 @@ wasefire-applet-api = { version = "0.6.0", path = "../api", features = ["host"]
 wasefire-board-api = { version = "0.6.1-git", path = "../board" }
 wasefire-error = { version = "0.1.0", path = "../error" }
 wasefire-logger = { version = "0.1.4", path = "../logger" }
-wasefire-store = { version = "0.2.3", path = "../store", optional = true }
+wasefire-store = { version = "0.2.4-git", path = "../store", optional = true }
 wasefire-sync = { version = "0.1.0", path = "../sync" }
 
 [dependencies.wasefire-interpreter]

crates/store/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.2.4-git
+
+### Patch
+
+- Use pure ASCII instead of UTF-8 in documentation
+
 ## 0.2.3
 
 ### Minor

crates/store/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "wasefire-store"
-version = "0.2.3"
+version = "0.2.4-git"
 authors = ["Julien Cretin <[email protected]>"]
 license = "Apache-2.0"
 publish = true

crates/store/src/format.rs

@@ -208,7 +208,7 @@ impl Format {
 
     /// The number of pages in the storage, denoted by N.
     ///
-    /// We have [`MIN_NUM_PAGES`] ≤ N ≤ [`MAX_PAGE_INDEX`] + 1.
+    /// We have [`MIN_NUM_PAGES`] <= N <= [`MAX_PAGE_INDEX`] + 1.
     pub fn num_pages(&self) -> Nat {
         self.num_pages
     }
@@ -222,7 +222,7 @@ impl Format {
 
     /// The maximum number of times a page can be erased, denoted by E.
     ///
-    /// We have E ≤ [`MAX_ERASE_CYCLE`].
+    /// We have E <= [`MAX_ERASE_CYCLE`].
     pub fn max_page_erases(&self) -> Nat {
         self.max_page_erases
     }
@@ -241,7 +241,7 @@ impl Format {
     ///
     /// A virtual page is stored in a physical page after the page header.
     ///
-    /// We have [`MIN_PAGE_SIZE`] - 2 ≤ Q ≤ [`MAX_VIRT_PAGE_SIZE`].
+    /// We have [`MIN_PAGE_SIZE`] - 2 <= Q <= [`MAX_VIRT_PAGE_SIZE`].
     pub fn virt_page_size(&self) -> Nat {
         self.page_size() / self.word_size() - CONTENT_WORD
     }
@@ -258,7 +258,7 @@ impl Format {
     /// A prefix is the first words of a virtual page that belong to the last entry of the previous
     /// virtual page. This happens because entries may overlap up to 2 virtual pages.
     ///
-    /// We have [`MIN_PAGE_SIZE`] - 3 ≤ M < Q.
+    /// We have [`MIN_PAGE_SIZE`] - 3 <= M < Q.
     pub fn max_prefix_len(&self) -> Nat {
         self.bytes_to_words(self.max_value_len())
     }
@@ -268,7 +268,7 @@ impl Format {
     /// This is the span of virtual storage that is accessible. In particular, all store content
     /// fits within this window.
     ///
-    /// We have W = (N - 1) × Q - M.
+    /// We have W = (N - 1) * Q - M.
     pub fn window_size(&self) -> Nat {
         (self.num_pages() - 1) * self.virt_page_size() - self.max_prefix_len()
     }
@@ -279,19 +279,19 @@ impl Format {
     /// than the virtual window because compaction may transiently overflow out of this virtual
     /// capacity.
     ///
-    /// We have V = W - (N - 1) = (N - 1) × (Q - 1) - M.
+    /// We have V = W - (N - 1) = (N - 1) * (Q - 1) - M.
     pub fn virt_size(&self) -> Nat {
         (self.num_pages() - 1) * (self.virt_page_size() - 1) - self.max_prefix_len()
     }
 
     /// The total user capacity in words, denoted by C.
     ///
-    /// We have C = V - N = (N - 1) × (Q - 2) - M - 1.
+    /// We have C = V - N = (N - 1) * (Q - 2) - M - 1.
     ///
-    /// We can show C ≥ (N - 2) × (Q - 2) - 2 with the following steps:
-    /// - M ≤ Q - 1 from M < Q from [M](Format::max_prefix_len)'s definition
-    /// - C ≥ (N - 1) × (Q - 2) - (Q - 1) - 1 from C's definition
-    /// - C ≥ (N - 2) × (Q - 2) - 2 by calculus
+    /// We can show C >= (N - 2) * (Q - 2) - 2 with the following steps:
+    /// - M <= Q - 1 from M < Q from [M](Format::max_prefix_len)'s definition
+    /// - C >= (N - 1) * (Q - 2) - (Q - 1) - 1 from C's definition
+    /// - C >= (N - 2) * (Q - 2) - 2 by calculus
     pub fn total_capacity(&self) -> Nat {
         // From the virtual capacity, we reserve N - 1 words for `Erase` entries and 1 word for a
         // `Clear` entry.
@@ -300,7 +300,7 @@ impl Format {
 
     /// The total virtual lifetime in words, denoted by L.
     ///
-    /// We have L = (E × N + N - 1) × Q.
+    /// We have L = (E * N + N - 1) * Q.
     pub fn total_lifetime(&self) -> Position {
         Position::new(self, self.max_page_erases(), self.num_pages() - 1, 0)
     }
@@ -705,7 +705,7 @@ bitfield! {
 /// - p denote a page offset, thus between 0 and N - 1
 /// - c denote the number of times a page was erased, thus between 0 and E
 ///
-/// The position of a word is (c × N + p) × Q + w. This position monotonically increases and
+/// The position of a word is (c * N + p) * Q + w. This position monotonically increases and
 /// represents the consumed lifetime of the storage.
 ///
 /// This type is kept abstract to avoid possible confusion with [`Nat`] and [`Word`] if they happen