From b5075d778491eb1def780eb493b05dda7a39f52d Mon Sep 17 00:00:00 2001 From: John Nonweiler Date: Tue, 10 Jul 2018 11:21:17 +0100 Subject: [PATCH 1/5] Document git submodule update in COMPILING.md --- COMPILING.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/COMPILING.md b/COMPILING.md index 96c3b3d27c7..ba21bd663b8 100644 --- a/COMPILING.md +++ b/COMPILING.md @@ -66,7 +66,7 @@ We assume that you have a Debian/Ubuntu or Red Hat-like distribution. 5. To compile JBMC, do ``` - make -C jbmc/src java-models-library-download + make -C jbmc/src setup-submodules make -C jbmc/src ``` @@ -92,7 +92,7 @@ We assume that you have a Debian/Ubuntu or Red Hat-like distribution. ``` 4. To compile JBMC, type ``` - gmake -C jbmc/src java-models-library-download + gmake -C jbmc/src setup-submodules gmake -C jbmc/src ``` @@ -118,7 +118,7 @@ We assume that you have a Debian/Ubuntu or Red Hat-like distribution. ``` 4. To compile JBMC, do ``` - gmake -C jbmc/src java-models-library-download + gmake -C jbmc/src setup-submodules gmake -C jbmc/src ``` @@ -144,7 +144,7 @@ Follow these instructions: ``` 4. To compile JBMC, do ``` - make -C jbmc/src java-models-library-download + make -C jbmc/src setup-submodules make -C jbmc/src ``` @@ -187,7 +187,7 @@ Follow these instructions: ``` 5. To compile JMBC, open the Cygwin shell and type ``` - make -C jbmc/src java-models-library-download + make -C jbmc/src setup-submodules make -C jbmc/src ``` @@ -240,7 +240,11 @@ require manual modification of build files. 2. Navigate to the *top level* folder of the project. This is different from the Makefile build, which requires you to navigate to the `src` directory first. -3. Generate build files with CMake: +3. Update git submodules: + ``` + git submodule update --init --recursive + ``` +4. Generate build files with CMake: ``` cmake -H. -Bbuild ``` @@ -264,7 +268,7 @@ require manual modification of build files. Finally, to enable building universal binaries on macOS, you can pass the flag `-DCMAKE_OSX_ARCHITECTURES=i386;x86_64`. If you don't supply this flag, the build will just be for the architecture of your machine. -4. Run the build: +5. Run the build: ``` cmake --build build ``` From d5f3c329eb2bcdc74707777e6a5de8cbf9419b38 Mon Sep 17 00:00:00 2001 From: John Nonweiler Date: Tue, 10 Jul 2018 14:05:20 +0100 Subject: [PATCH 2/5] Fix a typo JMBC->JBMC --- COMPILING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/COMPILING.md b/COMPILING.md index ba21bd663b8..1b01f4f5e98 100644 --- a/COMPILING.md +++ b/COMPILING.md @@ -185,7 +185,7 @@ Follow these instructions: make -C src DOWNLOADER=wget minisat2-download make -C src ``` -5. To compile JMBC, open the Cygwin shell and type +5. To compile JBMC, open the Cygwin shell and type ``` make -C jbmc/src setup-submodules make -C jbmc/src From 206f7fb2dbb2215135ca2fd24233a7d1cbf6a1bc Mon Sep 17 00:00:00 2001 From: John Nonweiler Date: Tue, 10 Jul 2018 15:37:34 +0100 Subject: [PATCH 3/5] Include submodule update in jbmc/README.md --- jbmc/README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/jbmc/README.md b/jbmc/README.md index 74b65dd3d2a..20f20bff24d 100644 --- a/jbmc/README.md +++ b/jbmc/README.md @@ -27,10 +27,15 @@ JBMC compiles CBMC as part of its build process and as such has all the pre-requ Compilation =========== -To compile you need to run the command: +Before compilation, update git submodules using the command: + +```bash +make -C jbmc/src setup-submodules +``` + +Then compile using: ```bash -make -C jbmc/src java-models-library-download make -C jbmc/src ``` From f7ddb02b850f683590c86104576007fdae98bb1f Mon Sep 17 00:00:00 2001 From: John Nonweiler Date: Tue, 10 Jul 2018 15:40:18 +0100 Subject: [PATCH 4/5] Remove --recursive from git submodule update --- COMPILING.md | 2 +- jbmc/src/Makefile | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/COMPILING.md b/COMPILING.md index 1b01f4f5e98..48d879e80d8 100644 --- a/COMPILING.md +++ b/COMPILING.md @@ -242,7 +242,7 @@ require manual modification of build files. first. 3. Update git submodules: ``` - git submodule update --init --recursive + git submodule update --init ``` 4. Generate build files with CMake: ``` diff --git a/jbmc/src/Makefile b/jbmc/src/Makefile index f798948cd73..83dd32eee29 100644 --- a/jbmc/src/Makefile +++ b/jbmc/src/Makefile @@ -55,7 +55,7 @@ dist_clean: rm -rf $(ROOT)dist setup-submodules: - git submodule update --init --recursive + git submodule update --init .PHONY: dist dist: setup-submodules all From aad16926be8f9de19dacd175859aa70e4cfdb5f5 Mon Sep 17 00:00:00 2001 From: John Nonweiler Date: Thu, 12 Jul 2018 09:30:32 +0100 Subject: [PATCH 5/5] Add minisat download to jbmc/README.md --- jbmc/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/jbmc/README.md b/jbmc/README.md index 20f20bff24d..c7e2a8c6aab 100644 --- a/jbmc/README.md +++ b/jbmc/README.md @@ -27,9 +27,10 @@ JBMC compiles CBMC as part of its build process and as such has all the pre-requ Compilation =========== -Before compilation, update git submodules using the command: +Before compilation, run the commands: ```bash +make -C src DOWNLOADER=wget minisat2-download make -C jbmc/src setup-submodules ```