From 7f523f4be2cf4171a68dda685d37d553f9e5f067 Mon Sep 17 00:00:00 2001 From: lethosor Date: Thu, 12 Jul 2018 10:30:57 -0400 Subject: [PATCH] Mention the need to initialize new submodules after `git pull` too See #1361 --- docs/Compile.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/Compile.rst b/docs/Compile.rst index 7d7dbeccd..18b0dc9b2 100644 --- a/docs/Compile.rst +++ b/docs/Compile.rst @@ -33,13 +33,16 @@ To get the latest development code (develop branch), clone as above and then:: Generally, you should only need to clone DFHack once. -**Important note regarding submodule update and changing branches**: - -You must run ``git submodule update`` every time you change branches, -such as when switching between the master and develop branches or vice versa. -If a submodule only exists on the newer branch, you also need to run -``git submodule update --init``. Failure to do this may result in strange -build errors or "not a known DF version" errors. +**Important note regarding submodule update after pulling or changing branches**: + +You must run ``git submodule update`` every time you change branches, such as +when switching between the master and develop branches or vice versa. You also +must run it after pulling any changes to submodules from the DFHack repo. If a +submodule only exists on the newer branch, or if a commit you just pulled +contains a new submodule, you need to run ``git submodule update --init``. +Failure to do this may result in a variety of errors, including ``fatal: +does not exist`` when using Git, errors when building DFHack, and ``not a known +DF version`` when starting DF. **More notes**: