Skip to content

Document git submodule update in COMPILING.md #2570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 12, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions COMPILING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
```

Expand All @@ -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
```

Expand All @@ -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
```

Expand Down Expand Up @@ -185,9 +185,9 @@ 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 java-models-library-download
make -C jbmc/src setup-submodules
make -C jbmc/src
```

Expand Down Expand Up @@ -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
```
4. Generate build files with CMake:
```
cmake -H. -Bbuild
```
Expand All @@ -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
```
Expand Down
10 changes: 8 additions & 2 deletions jbmc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,16 @@ 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, run the commands:

```bash
make -C src DOWNLOADER=wget minisat2-download
make -C jbmc/src setup-submodules
```

Then compile using:

```bash
make -C jbmc/src java-models-library-download
make -C jbmc/src
```

Expand Down
2 changes: 1 addition & 1 deletion jbmc/src/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down