Skip to content

Commit 1fd4327

Browse files
docs: add submodule init/sync prerequisite steps
Address Copilot review: document `git submodule update --init` for first-time checkouts and `git submodule sync` after URL/branch changes in .gitmodules, before running `--remote` to advance the submodule. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 130d1ef commit 1fd4327

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

DEVELOPER.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,12 @@ Provenance uses git submodules for emulator cores. Each core submodule is pinned
112112
When a Provenance-Emu fork submodule has a `branch = <name>` entry and you want to advance it:
113113

114114
```bash
115+
# If this is a first-time checkout, ensure the submodule is initialized:
116+
git submodule update --init Cores/<CoreName>/<submodule-dir>
117+
118+
# If you changed the submodule's URL or branch in .gitmodules, sync the local config:
119+
git submodule sync -- Cores/<CoreName>/<submodule-dir>
120+
115121
# Sync just that submodule to the remote branch HEAD.
116122
# Do NOT use --merge here: submodules are usually in detached-HEAD state after
117123
# a normal checkout and --merge will fail or produce unexpected results.

0 commit comments

Comments
 (0)