Skip to content

Commit cefbe31

Browse files
committed
style: remove decorative symbols from documentation, comments and workflow comments
Table cells whose value was carried by a symbol alone now carry a word (yes, no, partial, planned); three comment lists that distinguished accepted from refused forms keep the distinction in words.
1 parent 6937759 commit cefbe31

217 files changed

Lines changed: 1268 additions & 1268 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/actions/bootstrap-mcpp/action.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ runs:
4242
uses: actions/cache@v4
4343
with:
4444
path: ~/.mcpp
45-
# ⚠️⚠️ `runner.arch` IS PART OF EVERY KEY, AND WAS NOT.
45+
# `runner.arch` IS PART OF EVERY KEY, AND WAS NOT.
4646
#
4747
# These caches hold INSTALLED BINARIES — `~/.xlings`, `~/.mcpp`, and
4848
# `target/`. Keyed on `runner.os` alone, `Linux` names two machines, and
@@ -52,7 +52,7 @@ runs:
5252
# Cache hit for: xlings-Linux-v2-xl2026.8.17.2-…
5353
# …/bin/xlings: cannot execute binary file: Exec format error
5454
#
55-
# AND IT SURVIVED THE FIX ONE LAYER DOWN. Reading `uname -m` to pick
55+
# AND IT SURVIVED THE FIX ONE LAYER DOWN. Reading `uname -m` to pick
5656
# the right tarball is correct and was not enough: the download never
5757
# happened, because a cache from the other architecture was already
5858
# there. A key that does not name the machine is a key that lets one
@@ -88,7 +88,7 @@ runs:
8888
REPO_DIR="$(pwd)"
8989
# Always install the pinned version — the cache may hold an older
9090
# xlings whose sysroot/packages are incompatible.
91-
# ⚠️⚠️ THE ARCHITECTURE IS READ, NOT ASSUMED. This branched on the OS
91+
# THE ARCHITECTURE IS READ, NOT ASSUMED. This branched on the OS
9292
# alone and named `linux-x86_64` for every non-Darwin host, which is
9393
# invisible until a Linux runner is not x86_64. Measured on
9494
# `ubuntu-24.04-arm`, the first time this repo scheduled one:
@@ -117,7 +117,7 @@ runs:
117117
"https://github.com/d2learn/xlings/releases/download/v${XLINGS_VERSION}/${tarball}" \
118118
"${WORK}/${tarball}"
119119
tar -xzf "${WORK}/${tarball}" -C "${WORK}"
120-
# ⚠️⚠️ THE TWO LINUX TARBALLS DO NOT HAVE THE SAME SHAPE, and this line
120+
# THE TWO LINUX TARBALLS DO NOT HAVE THE SAME SHAPE, and this line
121121
# named one of them. Measured on the 2026.8.17.2 assets:
122122
#
123123
# linux-x86_64 → subos/default/bin/xlings (513 entries)
@@ -126,12 +126,12 @@ runs:
126126
# so fetching the right architecture — the fix immediately above — got
127127
# as far as `No such file or directory`, exit 127.
128128
#
129-
# FOUND RATHER THAN ASSUMED, AND THE SEARCH IS BOUNDED. `-maxdepth 5`
129+
# FOUND RATHER THAN ASSUMED, AND THE SEARCH IS BOUNDED. `-maxdepth 5`
130130
# keeps it from wandering into the payload tree, and an empty result is
131131
# a hard error: a bootstrap that silently continues without xlings fails
132132
# forty lines later on something that reads like a different problem.
133133
#
134-
# ⚠️ CHECKED BEFORE CHANGING THE THREE HOSTS THAT ALREADY WORKED. On
134+
# CHECKED BEFORE CHANGING THE THREE HOSTS THAT ALREADY WORKED. On
135135
# x86_64 this now resolves `bin/xlings` where the line before named
136136
# `subos/default/bin/xlings` — and those are the same file:
137137
#
@@ -212,7 +212,7 @@ runs:
212212
uses: actions/cache@v4
213213
with:
214214
path: target
215-
# ⚠️ `modules/**` belongs here as much as `src/**` does. mcpp's own
215+
# `modules/**` belongs here as much as `src/**` does. mcpp's own
216216
# source lives in both since the subsystem split, and a key that hashed
217217
# only one of them would restore a target/ built from different sources
218218
# and report success — the failure mode a cache key exists to prevent,

.github/tools/check_aarch64_llvm_deferral.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
#!/usr/bin/env bash
2-
# ⭐⭐ A DEFERRAL'S PREMISE, RECHECKED.
2+
# A DEFERRAL'S PREMISE, RECHECKED.
33
#
44
# `available_toolchain_indexes()` omits llvm on non-x86_64 Linux because no
55
# linux-aarch64 llvm exists — not in xlings-res, and not upstream since 19.x.
66
# That is a deferral, and a deferral nobody rechecks is indistinguishable from
77
# a defect.
88
#
9-
# ⚠️ THIS FAILS WHEN THE REASON STOPS HOLDING, which is the opposite of what a
9+
# THIS FAILS WHEN THE REASON STOPS HOLDING, which is the opposite of what a
1010
# check usually does. The day an aarch64 llvm is published, it goes red and
1111
# names the gate to remove — see
1212
# `.agents/docs/2026-08-26-aarch64-linux-ecosystem-closure.md` §P1.
1313
#
14-
# ⚠️ Network trouble must not be read as "it appeared". An unreadable asset list
14+
# Network trouble must not be read as "it appeared". An unreadable asset list
1515
# leaves the premise alone and says so: a check that turns a flaky API into a
1616
# claim about the world is worse than no check.
1717
set -uo pipefail

.github/tools/check_modules_wiring.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ done
122122
# report success -- the exact failure a cache key exists to prevent, arriving
123123
# silently. Found by sweeping for stale paths after the split, not by a test.
124124
#
125-
# ⚠️ THE UNIT IS THE LINE, NOT THE FILE. The first version asked whether the
125+
# THE UNIT IS THE LINE, NOT THE FILE. The first version asked whether the
126126
# FILE mentioned `modules/**`, and passed — satisfied by the comment sitting
127127
# above the key explaining why `modules/**` belongs there. A check that a
128128
# comment can satisfy is checking the prose.

.github/tools/check_narrow_conversions.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ cd "$REPO_DIR" || { echo "FAIL: cannot cd to $REPO_DIR" >&2; exit 1; }
7676
# So: a pass here does NOT mean "the tree is audited". It means no NEW direct
7777
# narrowing was written where this class originates.
7878
#
79-
# ⚠️ `modules/manifest/src/glob.cppm` is in scope even though the rest of that
79+
# `modules/manifest/src/glob.cppm` is in scope even though the rest of that
8080
# package is not. It is the glob walker itself -- the file this guard's
8181
# background note names -- and it moved out of `src/modgraph/` in the subsystem
8282
# split. A scope written as directory names shrinks silently when a file moves,

.github/tools/fetch_release.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
# every unexplained red on this branch, always inside 12 seconds, always with no
1717
# test name in the log.
1818
#
19-
# ⚠️ `curl --retry` ALONE DOES NOT COVER IT. `--retry` handles timeouts and a
19+
# `curl --retry` ALONE DOES NOT COVER IT. `--retry` handles timeouts and a
2020
# specific list of 5xx responses; an empty reply is a *transport* error and is
2121
# not on that list. `--retry-all-errors` (curl 7.71+) is the flag that does, and
2222
# it is the one that was missing. The outer loop below is not redundant with it:

.github/tools/install_released_mcpp.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
# the version under test — and failing outright, because only the latter was
2121
# installed:
2222
#
23-
# 1 package(s) installed
23+
# 1 package(s) installed
2424
# [error] xlings: version '2026.8.3.2' not found for 'mcpp'
2525
# [error] available: 2026.8.3.4
2626
#

.github/tools/mirror_res.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ hosts=()
287287
[[ "${GTC_ENABLED:-0}" == 1 ]] && hosts+=("gitcode.com/$GTC_DST")
288288
for host in "${hosts[@]}"; do
289289
for a in "${ASSETS[@]}"; do
290-
# ⚠️ RETRIED, BECAUSE A MIRROR CAN ANSWER 502 FOR AN ASSET IT HOLDS.
290+
# RETRIED, BECAUSE A MIRROR CAN ANSWER 502 FOR AN ASSET IT HOLDS.
291291
# v2026.8.25.1 failed here twice: every one of the 16 assets reported
292292
# "already mirrored, skipping", and the gate then failed one of them on a
293293
# single 502 from GitCode's edge. Fetched by hand a minute later it was
@@ -297,7 +297,7 @@ for host in "${hosts[@]}"; do
297297
# HTTP codes but not the transport-layer failures this path also sees, and
298298
# this repository has paid for that distinction before (ci-curl-52).
299299
#
300-
# ⚠️ `|| echo ERR` APPENDS, it does not replace — `-f` makes curl exit
300+
# `|| echo ERR` APPENDS, it does not replace — `-f` makes curl exit
301301
# non-zero on 502 while `-w` has already written the code, so the variable
302302
# read `502ERR` and the log could not be grepped for a status. Substituted
303303
# only when curl printed nothing at all.

.github/workflows/aur-publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ jobs:
128128
)
129129
[[ -z "$REQUESTED_TAG" ]] || args+=(--tag "$REQUESTED_TAG")
130130
131-
# ⚠️ EXIT 75 IS "THE PUSH LANDED, THE AUR'S INDEX HAS NOT CAUGHT UP",
131+
# EXIT 75 IS "THE PUSH LANDED, THE AUR'S INDEX HAS NOT CAUGHT UP",
132132
# AND FAILING ON IT MAKES THIS REPOSITORY'S CI RED FOR SOMEBODY ELSE'S
133133
# REFRESH SCHEDULE.
134134
#
@@ -142,7 +142,7 @@ jobs:
142142
# `AUR RPC did not converge to <ver>` and the AUR RPC answered with
143143
# that exact version when asked afterwards.
144144
#
145-
# ⚠️ EVERY OTHER NON-ZERO CODE STILL FAILS. A refused downgrade (3) and
145+
# EVERY OTHER NON-ZERO CODE STILL FAILS. A refused downgrade (3) and
146146
# a permanent error (2) are this repository's problem and stay red.
147147
set +e
148148
python3 scripts/aur/reconcile_mcpp_bin.py "${args[@]}"

.github/workflows/ci-linux-e2e.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ jobs:
132132
133133
- name: Install the emulator (xim:qemu-riscv)
134134
run: |
135-
# ⚠️ BOTH homes. The shim on PATH dispatches against whichever home
135+
# BOTH homes. The shim on PATH dispatches against whichever home
136136
# owns it, and `mcpp run` runs the runner through that shim — so an
137137
# emulator installed only in the ambient xlings home answers
138138
# "xlings: 'qemu-system-riscv64' is not installed" when mcpp asks.
@@ -153,7 +153,7 @@ jobs:
153153
XLINGS_HOME="${MCPP_HOME:-$HOME/.mcpp}/registry" \
154154
"$XLINGS_BIN" install xim:picolibc-riscv -y
155155
test -d "${MCPP_HOME:-$HOME/.mcpp}/registry/data/xpkgs/xim-x-picolibc-riscv"
156-
# ⚠️ The M-profile emulator, in BOTH homes for the reason above.
156+
# The M-profile emulator, in BOTH homes for the reason above.
157157
# `xim:qemu-arm` carries `qemu-system-arm` as well as
158158
# `qemu-system-aarch64`; test 332 addresses it by absolute path out of
159159
# the payload, so what matters is that the payload EXISTS in the home
@@ -211,19 +211,19 @@ jobs:
211211
grep -q 'PASS: the freestanding std subset' \
212212
133_freestanding_std_subset.sh.log || {
213213
echo "133 (std subset) skipped on the runner that must run it"; exit 1; }
214-
# ⚠️ 332 declares `# requires: qemu-arm`, which no sharded runner has
214+
# 332 declares `# requires: qemu-arm`, which no sharded runner has
215215
# — so on the shards it exits 0 without running. This job is the only
216216
# place its PASS line can be demanded.
217217
grep -q 'PASS: cortex-m rows build, boot' \
218218
332_cortex_m_builds_and_boots.sh.log || {
219219
echo "332 (cortex-m) skipped on the runner that must run it"; exit 1; }
220-
# And a count, because four `grep -q` calls that each matched say
220+
# And a count, because four `grep -q` calls that each matched say
221221
# nothing about how many rows the script actually booted: a fixture
222222
# that stopped iterating would still print its PASS line.
223223
booted=$(grep -c 'booted on ' 332_cortex_m_builds_and_boots.sh.log || true)
224224
[ "$booted" = "4" ] || {
225225
echo "332 booted $booted rows, expected 4"; exit 1; }
226-
# ⚠️ 336 IS HERE FOR THE SAME REASON, AND ADDING IT TO THE LOOP ABOVE
226+
# 336 IS HERE FOR THE SAME REASON, AND ADDING IT TO THE LOOP ABOVE
227227
# WITHOUT ADDING IT HERE WOULD HAVE BEEN THE SAME DEFECT: it declares
228228
# `# requires: qemu-arm`, so on a shard it exits 0 having run nothing.
229229
grep -q 'PASS: armv7-a rows build, boot' \
@@ -232,7 +232,7 @@ jobs:
232232
a32=$(grep -c 'booted on virt' 336_armv7a_builds_and_boots.sh.log || true)
233233
[ "$a32" = "2" ] || {
234234
echo "336 booted $a32 rows, expected 2"; exit 1; }
235-
# ⚠️ 338 SKIPS UNTIL `xim:picolibc-arm` IS PUBLISHED, and a skip here
235+
# 338 SKIPS UNTIL `xim:picolibc-arm` IS PUBLISHED, and a skip here
236236
# is legitimate rather than a defect — the payload is a separate
237237
# release. So its PASS line is NOT demanded; what IS demanded is that
238238
# the script either passed or said why, which is what distinguishes a

.github/workflows/ci-linux.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ jobs:
7979

8080
# Same placement, same reason: pure text, no toolchain.
8181
#
82-
# ⚠️ IT PRINTS AND DOES NOT FAIL, DELIBERATELY. The three rules it carries
82+
# IT PRINTS AND DOES NOT FAIL, DELIBERATELY. The three rules it carries
8383
# each have real false positives — a control step legitimately pins one
8484
# target, a `grep -q .` legitimately expects output — and the whole value
8585
# of the thing is that somebody READS it. A hard gate would be routed
@@ -124,7 +124,7 @@ jobs:
124124
- name: Per-subsystem tests (`mcpp test -p <member>`)
125125
run: |
126126
set -euo pipefail
127-
# ⚠️ `$MCPP_FRESH` comes from the step above, which takes the NEWEST
127+
# `$MCPP_FRESH` comes from the step above, which takes the NEWEST
128128
# mcpp anywhere under target/. That is correct in this job because
129129
# nothing between the two steps writes another one — but `mcpp pack`
130130
# leaves a copy under `target/dist/`, and a pack step inserted above

0 commit comments

Comments
 (0)