From 32fd3f79b597ae09045bdaa5d703833c8b7af2f7 Mon Sep 17 00:00:00 2001 From: PisonJay Date: Tue, 15 Nov 2022 16:26:06 +0800 Subject: [PATCH] Fix typo in Initial-Repo-Setup.rst --- docs/Chipyard-Basics/Initial-Repo-Setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Chipyard-Basics/Initial-Repo-Setup.rst b/docs/Chipyard-Basics/Initial-Repo-Setup.rst index 1c322da5cc..6e481e9c9c 100644 --- a/docs/Chipyard-Basics/Initial-Repo-Setup.rst +++ b/docs/Chipyard-Basics/Initial-Repo-Setup.rst @@ -72,7 +72,7 @@ Run the following script based off which compiler you would like to use. This script wraps around the conda environment initialization process and also runs the ``init-submodules-no-riscv-tools.sh`` and ``build-toolchain-extra.sh`` scripts. -The ``init-subodules-no-riscv-tools.sh`` script will initialize and checkout all of the necessary git submodules. +The ``init-submodules-no-riscv-tools.sh`` script will initialize and checkout all of the necessary git submodules. This will also validate that you are on a tagged branch, otherwise it will prompt for confirmation. When updating Chipyard to a new version, you will also want to rerun this script to update the submodules. Using ``git`` directly will try to initialize all submodules; this is not recommended unless you expressly desire this behavior.