refactor: drop --shallow-submodules since lwIP submodule does not support shallow clone
What the developer wrote
Authored by tadeubas
refactor: drop --shallow-submodules since lwIP submodule does not support shallow clone
What changed, and why it matters
This commit only updates the README.md build instructions. It removes the recommended 'fast' git clone command that used shallow submodules, because one submodule (lwIP) does not support shallow cloning. It leaves only the full recursive clone command. There is no firmware code change and no security fix or vulnerability introduced.
No security action needed. Treat as a routine documentation update.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies README.md only. It deletes the documented git clone --depth 1 --shallow-submodules --recursive option and collapses the instructions to a single git clone --recursive command. The stated reason is that the lwIP submodule fails with --shallow-submodules. No source files, build scripts, cryptographic code, or hardware interaction logic are changed.
Changed components
README.md documentationInspect captured patch +0 / −6
diff --git a/README.md b/README.md
index 3aae27c..e0cbbb7 100644
--- a/README.md
+++ b/README.md
@@ -179,13 +179,7 @@ All steps you need to install and run the Coldcard simulator on Ubuntu 20.04:
apt install build-essential git python3 python3-pip libudev-dev gcc-arm-none-eabi libffi-dev xterm swig libpcsclite-dev python-is-python3 autoconf libtool python3-venv
# Get sources, this takes a long time (because of external libraries), then open
-
-# Recommended (fast, minimal download; sufficient for building and running the simulator):
-git clone --depth 1 --shallow-submodules --recursive https://github.com/Coldcard/firmware.git
-
-# Full clone (developers only; required for history, bisecting, or contributing):
git clone --recursive https://github.com/Coldcard/firmware.git
-
cd firmware
# Apply address patch
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.