From 3122d9465a92d17252b8a791d9048fa5cfc9fc60 Mon Sep 17 00:00:00 2001 From: Hood Chatham Date: Sun, 24 Nov 2024 07:17:01 +0100 Subject: [PATCH] Update building-from-sources documentation to mention git submodules (#5220) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- docs/development/building-from-sources.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/development/building-from-sources.md b/docs/development/building-from-sources.md index 30958621a..0d6500e4f 100644 --- a/docs/development/building-from-sources.md +++ b/docs/development/building-from-sources.md @@ -24,6 +24,23 @@ Pyodide can be built from sources on different platforms, ## Build instructions +The Pyodide repository has a git submodule called `pyodide-build`. Make sure to +do a recursive clone: + +```bash +git clone --recursive https://github.com/pyodide/pyodide +``` + +or if you have already cloned the Pyodide repository without the `--recursive` +flag, you may initialize the submodule with: + +```bash +git submodule update --init +``` + +If you change git branches, make sure you update `pyodide-build` with +`git submodule update`. + ### Using Docker We provide a Debian-based x86_64 Docker image