mirror of
https://github.com/Abdess/retroarch_system.git
synced 2026-11-20 16:47:49 -06:00
docs: describe the scraper --revision option
This commit is contained in:
1 parent
dd1625d1fb
commit
298ea5fcb2
1 file changed
+2
-1
@@ -97,13 +97,14 @@ Returned by `compare_with_config()`. Contains:
|
|||||||
|
|
||||||
### scraper_cli
|
### 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 |
|
| Flag | Behavior |
|
||||||
|------|----------|
|
|------|----------|
|
||||||
| `--dry-run` | Fetch and print a summary grouped by system |
|
| `--dry-run` | Fetch and print a summary grouped by system |
|
||||||
| `--json` | Output all requirements as JSON |
|
| `--json` | Output all requirements as JSON |
|
||||||
| `--output FILE` | Write platform YAML to FILE |
|
| `--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
|
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
|
is replaced and the others are kept, as is a system's `data_directories` the new
|
||||||
|
|||||||
Reference in new issue
Block a user