From 1b1bc317789cc09defd4d682d1627ee10dcc5461 Mon Sep 17 00:00:00 2001 From: Michael Rebello Date: Sun, 16 Jun 2019 18:06:05 -0700 Subject: [PATCH] docs: add note on cloning recursively (#95) Signed-off-by: JP Simard --- mobile/docs/root/start/building/building.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/mobile/docs/root/start/building/building.rst b/mobile/docs/root/start/building/building.rst index fd9fa9b3973e..0838cb166e3d 100644 --- a/mobile/docs/root/start/building/building.rst +++ b/mobile/docs/root/start/building/building.rst @@ -9,6 +9,13 @@ In order to compile the artifacts used by the Envoy Mobile library, your system must also meet `these requirements for building Envoy `_. +Ensure that the ``envoy`` **submodule** is initialized when cloning by using ``--recursive``: + +``git clone https://github.com/lyft/envoy-mobile.git --recursive`` + +If the repo was not initially cloned recursively, initialize the Envoy +submodule with ``git submodule update --init``. + -------------------- Android requirements --------------------