From 60c723a3bf63012668e60f6840ccd20aac4877e9 Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Fri, 4 Sep 2026 11:43:38 +0200 Subject: [PATCH] docs: name the files adler32 belongs to The field reference carried the same attribution the FAQ did: known_hash_adler32 described as Dolphin's IPL files, when dolphin.yml declares it on dsp_rom.bin and dsp_coef.bin. The guard now scans every wiki page rather than the FAQ alone. --- tests/test_audit_regressions.py | 13 ++++++++++--- wiki/profiling.md | 2 +- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/tests/test_audit_regressions.py b/tests/test_audit_regressions.py index 9605a822..e1055e76 100644 --- a/tests/test_audit_regressions.py +++ b/tests/test_audit_regressions.py @@ -119,10 +119,17 @@ class FaqRegressions(unittest.TestCase): for name in carriers: self.assertIn(name, sentence, f"FAQ omits the Adler-32 file {name}") self.assertNotIn( - "IPL.bin", - {f["name"] for f in dolphin["files"] if f.get("known_hash_adler32")}, - "IPL.bin gained an Adler-32 hash; the FAQ says it has none", + "IPL.bin", carriers, + "IPL.bin gained an Adler-32 hash; the docs say it has none", ) + for page in ("faq.md", "profiling.md"): + text = (ROOT / "wiki" / page).read_text(encoding="utf-8") + for line in text.splitlines(): + if "Adler-32" in line or "adler32" in line: + self.assertNotIn( + "IPL", line, + f"wiki/{page} ties Adler-32 back to IPL: {line.strip()}", + ) def test_existence_platforms_are_not_told_the_verbose_report_is_the_only_check(self): self.assertIn( diff --git a/wiki/profiling.md b/wiki/profiling.md index 5e75586d..045770cb 100644 --- a/wiki/profiling.md +++ b/wiki/profiling.md @@ -352,7 +352,7 @@ which CI validates every profile against. | `size` | expected size in bytes; a list when the code accepts several exact sizes | | `min_size`, `max_size` | size range when the code accepts a range | | `md5`, `sha1`, `crc32`, `sha256` | expected hashes from source code | -| `known_hash_adler32` | expected Adler-32 hash (used by Dolphin IPL files) | +| `known_hash_adler32` | expected Adler-32 hash (Dolphin's DSP ROMs); pair with `adler32_byteswap` when the code hashes 16-bit byte-swapped data | | `validation` | checks the code performs: `size`, `crc32`, `md5`, `sha1`, `adler32`, `signature`, `crypto`. Can be a list or dict `{core: [...], upstream: [...]}` for divergent checks | | `aliases` | alternate filenames for the same file | | `mode` | `libretro`, `standalone`, or `both` |