docs: state the .info hash rule one way

This commit is contained in:
Abdessamad Derraz committed 2026-11-05 12:19:58 +01:00
1 parent e835c3862e
commit 3a36350f5c
2 files changed
+19 -5

No files matched your search

+12
View File
@@ -1758,6 +1758,18 @@ class VersionBasisReferenceIsTheSchema(unittest.TestCase):
self.assertIn("`unverified`", tools) self.assertIn("`unverified`", tools)
class ProfilingStatesTheHashRuleOnce(unittest.TestCase):
"""profiling.md let an .info MD5 in ('source confirmation makes it more
reliable') and a file the code never loads stay ('can be left out'),
beside the strict rule of the same paragraph."""
def test_no_permissive_form_remains(self):
page = (WIKI / "profiling.md").read_text(encoding="utf-8")
self.assertNotIn("source confirmation makes it more reliable", page)
self.assertNotIn("it can be left out of the profile", page)
self.assertIn("An MD5 the .info or\n the docs alone give is not written", page)
class ReportExcerptIsTheRun(unittest.TestCase): class ReportExcerptIsTheRun(unittest.TestCase):
"""reading-reports.md quoted 'From python scripts/verify.py --platform """reading-reports.md quoted 'From python scripts/verify.py --platform
retrodeck' a run that said 0 required missing after the command had started retrodeck' a run that said 0 required missing after the command had started
+7 -5
View File
@@ -383,8 +383,9 @@ A few field conventions that protect the toolchain:
string (like emuscv's `635a978...` in memory.cpp), that goes in. If string (like emuscv's `635a978...` in memory.cpp), that goes in. If
the source embeds ROM data as byte arrays (like ep128emu's roms.hpp), the source embeds ROM data as byte arrays (like ep128emu's roms.hpp),
the bytes can be extracted and hashed. If the source performs no hash the bytes can be extracted and hashed. If the source performs no hash
check at all, the hash is omitted from the profile. The .info or docs check at all, the hash is omitted from the profile. An MD5 the .info or
may list an MD5, but source confirmation makes it more reliable. the docs alone give is not written: pokketstation's `.info` names a
revision no copy in circulation has.
A data file the build generates is rebuilt from the tree and compared A data file the build generates is rebuilt from the tree and compared
byte for byte with the official release before its hash is recorded byte for byte with the official release before its hash is recorded
(PrBoom+ builds `prboom-plus.wad` with its own tool). A firmware URL that (PrBoom+ builds `prboom-plus.wad` with its own tool). A firmware URL that
@@ -493,9 +494,10 @@ and DSP firmware through different code paths. Checking the actual
code for each core avoids assumptions based on a related profile. code for each core avoids assumptions based on a related profile.
**Code over docs.** Wiki pages and README files sometimes reference **Code over docs.** Wiki pages and README files sometimes reference
files from older versions or a different fork. If the source code files from older versions or a different fork. A file the source code
does not load a particular file, it can be left out of the profile does not load is left out of the profile, even when documentation or the
even if documentation mentions it. `.info` mentions it (desmume2015's `.info` lists three firmware files its
code never opens).
## YAML field reference ## YAML field reference