From 298ea5fcb2fdb02c1a067bcb5ba3649eee55595d Mon Sep 17 00:00:00 2001 From: Abdessamad Derraz <3028866+Abdess@users.noreply.github.com> Date: Wed, 11 Nov 2026 14:31:31 +0100 Subject: [PATCH] docs: describe the scraper --revision option --- wiki/adding-a-scraper.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/wiki/adding-a-scraper.md b/wiki/adding-a-scraper.md index 06e89ce7d..d06bf4399 100644 --- a/wiki/adding-a-scraper.md +++ b/wiki/adding-a-scraper.md @@ -97,13 +97,14 @@ Returned by `compare_with_config()`. Contains: ### scraper_cli -`scraper_cli(scraper_class, description)` provides a shared CLI with three modes: +`scraper_cli(scraper_class, description)` provides a shared CLI: | Flag | Behavior | |------|----------| | `--dry-run` | Fetch and print a summary grouped by system | | `--json` | Output all requirements as JSON | | `--output FILE` | Write platform YAML to FILE | +| `--revision REF` | Read a branch head or a commit instead of the revision the platform file pins. Offered only to a scraper whose constructor takes `revision` (RetroBat), and passed by `check_freshness.py` and `refresh_stale.py` from the registry's `rescrape_args` | When `--output` targets an existing file, every top-level key the scraper writes is replaced and the others are kept, as is a system's `data_directories` the new