Update submodules to git submodule checkout method so they aren't clo…

…ned in hub repos. (#21)
FreeRTOS · Oct 14, 2020 · 80c3761 · 80c3761
1 parent c29f483
commit 80c3761
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 4 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -19,6 +19,7 @@ jobs:
           cmake -S test/unit-test -B build/ \
           -G "Unix Makefiles" \
           -DCMAKE_BUILD_TYPE=Debug \
+          -DBUILD_CLONE_SUBMODULES=ON \
           -DCMAKE_C_FLAGS='--coverage -Wall -Wextra -DNDEBUG'
           make -C build/ all
       - name: Test

diff --git a/.gitmodules b/.gitmodules
@@ -1,10 +1,13 @@
 [submodule "test/unit-test/CMock"]
 	path = test/unit-test/CMock
 	url = https://github.com/ThrowTheSwitch/CMock.git
+    update = none
 [submodule "3rdparty/mbedtls"]
 	path = 3rdparty/mbedtls
 	url = https://github.com/ARMmbed/mbedtls.git
     branch = mbedtls-2.16
+    update = none
 [submodule "3rdparty/pkcs11"]
 	path = 3rdparty/pkcs11
 	url = https://github.com/amazon-freertos/pkcs11.git
+    update = none
diff --git a/README.md b/README.md
@@ -25,9 +25,17 @@ A list of all the configurations and their default values are defined in the dox
 
 ### Steps to build **Library** and **Unit Tests**
 
-1. Go to the root directory of this repository.
+### Checkout CMock Submodule
+By default, the submodules in this repository are configured with `update=none` in [.gitmodules](.gitmodules) to avoid increasing clone time and disk space usage of other repositories (like [amazon-freertos](https://github.com/aws/amazon-freertos) that submodule this repository.
 
-1. Run *cmake* while inside build directory: `cmake -S ../test/unit-test -B build -DBUILD_CLONE_SUBMODULES=ON `
+To build unit tests, the submodule dependency of CMock is required. Use the following command to clone the submodule:
+```
+git submodule update --checkout --init --recursive test/unit-test/CMock
+```
+
+1. Go to the root directory of this repository. (Make sure that the **CMock** submodule is cloned as described [above](#checkout-cmock-submodule))
+
+1. Run *cmake* while inside build directory: `cmake -S ../test/unit-test -B build`
 
 1. Run this command to build the library and unit tests: `make -C build all`
 

diff --git a/test/unit-test/CMakeLists.txt b/test/unit-test/CMakeLists.txt
@@ -22,7 +22,7 @@ set(MODULE_ROOT_DIR ${__MODULE_ROOT_DIR} CACHE INTERNAL "corePKCS11 repository r
 # Configure options to always show in CMake GUI.
 option( BUILD_CLONE_SUBMODULES
         "Set this to ON to automatically clone any required Git submodules. When OFF, submodules must be manually cloned."
-        ON )
+        OFF )
 
 # Set output directories.
 set( CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin )

diff --git a/test/unit-test/cmock_build.cmake b/test/unit-test/cmock_build.cmake
@@ -3,7 +3,7 @@ macro( clone_cmock )
         find_package( Git REQUIRED )
         message( "Cloning submodule CMock." )
         execute_process( COMMAND rm -rf ${CMOCK_DIR}
-                         COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive ${MODULE_ROOT_DIR}
+                         COMMAND ${GIT_EXECUTABLE} submodule update --checkout --init --recursive ${MODULE_ROOT_DIR}
                         WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
                         RESULT_VARIABLE CMOCK_CLONE_RESULT )