mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-10-20 10:23:16 -05:00
docs: name the registries behind assets and dedup
The guides said files over 50 MB become release assets and that RPG Maker and ScummVM were the trees kept out of dedup. .gitignore decides the first, four committed files are over 50 MB, and NODEDUP_DIRS holds eleven trees.
This commit is contained in:
1 parent
303b1fbd5f
commit
18e093182d
8 files changed
+46
-11
No files matched your search
@@ -241,7 +241,7 @@ platform's own verification mode.
|
||||
| `zippedFile` entries | MD5 is of the ROM inside the ZIP, not the ZIP itself |
|
||||
| Regional variants (same filename) | `by_path_suffix` index disambiguates |
|
||||
| MAME BIOS ZIPs | `contents` field documents inner structure |
|
||||
| RPG Maker/ScummVM | excluded from dedup (NODEDUP) to preserve directory structure |
|
||||
| Trees addressed by path (RPG Maker, ScummVM, tzdata, c64-emu and the rest of `NODEDUP_DIRS`) | excluded from dedup to keep files that are equal by design |
|
||||
| `strip_components` in data dirs | flattens cache prefix to match expected path |
|
||||
| case-insensitive dedup | prevents `font.rom` + `FONT.ROM` conflicts on Windows/macOS |
|
||||
| frozen snapshot cores | `.info` may reflect current version while code is pinned to an old one. Only the frozen source at the pinned tag is reliable (e.g. desmume2015, mame2003) |
|
||||
|
||||
+1
-1
@@ -411,7 +411,7 @@ partitions), and `game_count`.
|
||||
| `description` | what this file is |
|
||||
| `note` | additional context |
|
||||
| `contents` | structure of files inside a BIOS ZIP (`name`, `description`, `size`, `crc32`) |
|
||||
| `storage` | `embedded` (default), `external`, `user_provided`, or `large_file`/`release` for files > 50 MB stored as release assets |
|
||||
| `storage` | `embedded` (default), `external`, `user_provided`, or `large_file`/`release` for files stored as release assets (listed in `.gitignore`) |
|
||||
| `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 |
|
||||
|
||||
@@ -124,8 +124,10 @@ merge, and again on the commit a direct push puts at the head of main.
|
||||
|
||||
## Large files management
|
||||
|
||||
Files larger than 50 MB are stored as assets on a permanent GitHub release
|
||||
named `large-files` (to keep the git repository lightweight).
|
||||
Files too large for git are stored as assets on a permanent GitHub release
|
||||
named `large-files`. Size does not decide it: four committed files are over
|
||||
50 MB (`history.xml`, `default-GM.sf3`, `5.avi`, `tbblue.mmc`) and are served
|
||||
from the repository like any other.
|
||||
|
||||
Examples: PS3UPDAT.PUP, PSVUPDAT.PUP, PSP2UPDAT.PUP, the DSi NAND images,
|
||||
maclc3.zip, Firmware.19.0.0.zip (Switch), the QEMU EDK2 firmware, the ScummVM
|
||||
|
||||
+4
-2
@@ -709,8 +709,10 @@ at. Writing is explicit: the pipeline only ever reports.
|
||||
|
||||
## Large files
|
||||
|
||||
Files over 50 MB are stored as assets on the `large-files` GitHub release.
|
||||
They are listed in `.gitignore` to keep the git repository lightweight.
|
||||
Files too large for git are stored as assets on the `large-files` GitHub
|
||||
release. `.gitignore` is the list of them: a `bios/` path listed there is a
|
||||
release asset, whatever its size, and a committed file is served from the
|
||||
repository even past 50 MB.
|
||||
`generate_db.py` downloads them from the release when rebuilding the database,
|
||||
using `fetch_large_file()` from `common.py`. The same function is used by
|
||||
`generate_pack.py` when a file has a hash mismatch with the local variant.
|
||||
|
||||
@@ -154,7 +154,7 @@ in [verification modes](verification-modes.md#severity-matrix).
|
||||
Focus on CRITICAL issues first. WARNING files improve the experience but aren't
|
||||
strictly necessary. INFO files are nice to have.
|
||||
|
||||
**Large files (over 50 MB):**
|
||||
**Large files (release assets):**
|
||||
|
||||
Files like PS3UPDAT.PUP, PSVUPDAT.PUP, and Switch firmware are too large for the
|
||||
git repository. They are stored as GitHub release assets under the `large-files`
|
||||
|
||||
Reference in new issue
Block a user