Skip to content

Commit e30436f

Browse files
committed
More notes on submodules in README.md.
1 parent 5bcd09f commit e30436f

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ Development will typically require one of the following editors:
5151
* JetBrains Rider
5252
* JetBrains Fleet
5353

54+
Note that you must clone the Git repository with the `--recursive` option as we
55+
make use of submodules.
56+
5457
Simply run `./cake` (a [Bash](https://www.gnu.org/software/bash) script) to
5558
build client artifacts for Windows (x64) and server artifacts for the current
5659
platform (Windows or Linux, x64 or Arm64). This will use the `Debug`
@@ -91,8 +94,15 @@ CREATE SCHEMA staging AUTHORIZATION arise;
9194
With this setup, and assuming you have PostgreSQL listening locally, you should
9295
now be able to successfully do `dotnet run --project src/server/daemon`.
9396

94-
For development purposes, you may wish to make the entire history of the
95-
submodules available by running `git submodule foreach git fetch --unshallow`.
97+
For development purposes, you will likely want to make some adjustments to the
98+
default submodule setup:
99+
100+
* `git submodule foreach git checkout master`: Switch all submodules from
101+
detached `HEAD` to tracking the actual branch. Without this, commits made in
102+
submodules might be lost.
103+
* `git submodule foreach git fetch --unshallow`: Make available the entire
104+
history of all submodules. Without this, tools like `git log` and `git blame`
105+
will be largely useless.
96106

97107
## Vendoring
98108

0 commit comments

Comments
 (0)