docs: send RetroPie users to the RetroPie pack

tests/test_which_pack.py

@@ -15,25 +15,31 @@ REPO_ROOT = Path(__file__).resolve().parents[1]
 sys.path.insert(0, str(REPO_ROOT / "scripts"))
 
 
+def _packs_of() -> dict[str, set[str]]:
+    """Each platform's display name, mapped to the platforms its pack serves."""
+    from common import (
+        group_identical_platforms,
+        list_registered_platforms,
+        load_platform_config,
+    )
+
+    platforms_dir = str(REPO_ROOT / "platforms")
+    registered = list_registered_platforms(platforms_dir, include_archived=True)
+    display = {
+        p: load_platform_config(p, platforms_dir).get("platform", p)
+        for p in registered
+    }
+    packs_of: dict[str, set[str]] = {}
+    for group, _rep in group_identical_platforms(registered, platforms_dir):
+        names = {display[p] for p in group}
+        for p in group:
+            packs_of[display[p]] = names
+    return packs_of
+
+
 class WhichPackRows(unittest.TestCase):
     def test_platform_rows_name_their_own_pack(self):
-        from common import (
-            group_identical_platforms,
-            list_registered_platforms,
-            load_platform_config,
-        )
-
-        platforms_dir = str(REPO_ROOT / "platforms")
-        registered = list_registered_platforms(platforms_dir, include_archived=True)
-        display = {
-            p: load_platform_config(p, platforms_dir).get("platform", p)
-            for p in registered
-        }
-        packs_of: dict[str, set[str]] = {}
-        for group, _rep in group_identical_platforms(registered, platforms_dir):
-            names = {display[p] for p in group}
-            for p in group:
-                packs_of[display[p]] = names
+        packs_of = _packs_of()
         source = (REPO_ROOT / "scripts" / "generate_site.py").read_text(encoding="utf-8")
         row = re.compile(r"^\| \[([^\]]+)\]\([^)]*\) \|[^|]*\| \[([^\]]+)\]\(\{rel\}\)", re.M)
         checked = 0
@@ -45,6 +51,22 @@ class WhichPackRows(unittest.TestCase):
                 self.assertIn(pack, packs_of[setup])
         self.assertGreater(checked, 5)
 
+    def test_getting_started_sends_each_platform_to_its_pack(self):
+        """Its RetroPie section said the RetroArch pack applies as well."""
+        packs_of = _packs_of()
+        text = (REPO_ROOT / "wiki" / "getting-started.md").read_text(encoding="utf-8")
+        section = text.split("## BIOS directory by platform", 1)[1].split("\n## ", 1)[0]
+        checked = 0
+        for block in section.split("\n### ")[1:]:
+            heading, _, body = block.partition("\n")
+            if heading not in packs_of:
+                continue
+            checked += 1
+            for named in [name for name in packs_of if f"{name} pack" in body]:
+                with self.subTest(section=heading, named=named):
+                    self.assertIn(named, packs_of[heading])
+        self.assertGreater(checked, 5)
+
 
 if __name__ == "__main__":
     unittest.main()

wiki/getting-started.md

@@ -189,8 +189,11 @@ Accessible via SSH or Samba.
 ```
 
 RetroPie is archived in this project: its configuration is kept and packs are
-still built, but the upstream data is no longer scraped on a schedule. It
-inherits RetroArch's file set, so the RetroArch pack applies as well.
+still built, but the upstream data is no longer scraped on a schedule. Use the
+RetroPie pack, not the RetroArch one: RetroPie inherits RetroArch's systems
+but also installs standalone emulators (openMSX, PCSX2, XRoar, Amiberry and
+others) whose files only the RetroPie pack carries, laid out for
+`~/RetroPie/BIOS/` rather than RetroArch's `system/`.
 
 ### ROCKNIX