kmoody/libretro
1
0
Fork 0
mirror of https://github.com/Abdess/retroarch_system.git synced 2026-04-13 12:22:33 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix factual errors in wiki pages

Browse Source
This commit is contained in:
Abdessamad Derraz
2026-04-02 17:13:59 +02:00
parent 92b270c054
commit c0e42ee4eb
4 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
wiki/faq.md
View File

@@ -93,9 +93,11 @@ Different platforms use different hash types for verification. Batocera uses MD5
## Why does my verification report say UNTESTED? ## Why does my verification report say UNTESTED?
UNTESTED means the file exists on disk but its hash was not confirmed against a known value. This happens on existence-mode platforms (RetroArch, Lakka, RetroPie) where the platform only checks that the file is present, without verifying its contents. UNTESTED means the file exists on disk but its hash does not match the expected value. This happens on MD5/SHA1-mode platforms (Batocera, Recalbox, BizHawk, etc.) when the file is present but contains different data than what the platform declares.
The file may still be correct. Running `verify.py --emulator <core> --verbose` shows the emulator-level ground truth, which can confirm whether the file's hash matches what the source code expects. On existence-mode platforms (RetroArch, Lakka, RetroPie), files are never UNTESTED because the platform only checks presence, not content. Those files show as OK if present.
Running `verify.py --emulator <core> --verbose` shows the emulator-level ground truth, which can confirm whether the file's hash matches what the source code expects.
## Can I use BIOS from one platform on another? ## Can I use BIOS from one platform on another?

2
wiki/index.md
View File

@@ -33,7 +33,7 @@ See [contributing](../CONTRIBUTING.md) for submission guidelines.
- **BIOS** - firmware burned into console hardware, needed by emulators that rely on original boot code - **BIOS** - firmware burned into console hardware, needed by emulators that rely on original boot code
- **firmware** - system software loaded by a console at boot; used interchangeably with BIOS in this project - **firmware** - system software loaded by a console at boot; used interchangeably with BIOS in this project
- **HLE** - High-Level Emulation; software reimplementation of BIOS functions, avoids needing the original file - **HLE** - High-Level Emulation; software reimplementation of BIOS functions, avoids needing the original file
- **hash** - fixed-length fingerprint of a file's contents; this project uses MD5, SHA1, SHA256, and CRC32 - **hash** - fixed-length fingerprint of a file's contents; this project uses MD5, SHA1, SHA256, CRC32, and Adler-32
- **platform** - a distribution that packages emulators (RetroArch, Batocera, Recalbox, EmuDeck, etc.) - **platform** - a distribution that packages emulators (RetroArch, Batocera, Recalbox, EmuDeck, etc.)
- **core** - an emulator packaged as a libretro plugin, loaded by RetroArch or compatible frontends - **core** - an emulator packaged as a libretro plugin, loaded by RetroArch or compatible frontends
- **profile** - a YAML file in `emulators/` documenting one core's BIOS requirements, verified against source code - **profile** - a YAML file in `emulators/` documenting one core's BIOS requirements, verified against source code

6
wiki/profiling.md
View File

@@ -275,7 +275,8 @@ even if documentation mentions it.
| `system` | system ID this file belongs to (for multi-system profiles) | | `system` | system ID this file belongs to (for multi-system profiles) |
| `size` | expected size in bytes | | `size` | expected size in bytes |
| `min_size`, `max_size` | size range when the code accepts a range | | `min_size`, `max_size` | size range when the code accepts a range |
| `md5`, `sha1`, `crc32`, `sha256`, `adler32` | expected hashes from source code | | `md5`, `sha1`, `crc32`, `sha256` | expected hashes from source code |
| `known_hash_adler32` | expected Adler-32 hash (used by Dolphin IPL files) |
| `validation` | checks the code performs: `size`, `crc32`, `md5`, `sha1`, `adler32`, `signature`, `crypto`. Can be a list or dict `{core: [...], upstream: [...]}` for divergent checks | | `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 | | `aliases` | alternate filenames for the same file |
| `mode` | `libretro`, `standalone`, or `both` | | `mode` | `libretro`, `standalone`, or `both` |
@@ -288,4 +289,7 @@ even if documentation mentions it.
| `note` | additional context | | `note` | additional context |
| `contents` | structure of files inside a BIOS ZIP (`name`, `description`, `size`, `crc32`) | | `contents` | structure of files inside a BIOS ZIP (`name`, `description`, `size`, `crc32`) |
| `storage` | `large_file` for files > 50 MB stored as release assets | | `storage` | `large_file` for files > 50 MB stored as release assets |
| `agnostic` | true if any file under the system path within size constraints satisfies the requirement |
| `unsourceable` | reason why the file cannot be sourced (acknowledged gap) |
| `destination` | target path within the BIOS directory |

4
wiki/troubleshooting.md
View File

@@ -18,8 +18,8 @@ cannot start games for that system at all.
**Check if the hash matches:** **Check if the hash matches:**
Look for `HASH_MISMATCH` in the verify output. This means the file exists but Look for `untested` entries in the verify output. This means the file exists but
contains different data than expected. Common causes: its hash does not match the expected value. Common causes:
- Wrong region (a PAL BIOS instead of NTSC, or vice versa) - Wrong region (a PAL BIOS instead of NTSC, or vice versa)
- Wrong hardware revision (e.g. SCPH-5501 vs SCPH-1001 for PlayStation) - Wrong hardware revision (e.g. SCPH-5501 vs SCPH-1001 for PlayStation)