From 7ba1b79881e2136697b743e38339ad66ad1549c6 Mon Sep 17 00:00:00 2001
From: Masahiro Fujiwara <4935351-masahiro_fujiwara@users.noreply.gitlab.com>
Date: Mon, 17 Jan 2022 14:48:09 +0900
Subject: [PATCH 1/2] fix typo
---
General/HowToCompileWithUbuntuInDocker.md | 40 +++++++++++------------
1 file changed, 20 insertions(+), 20 deletions(-)
diff --git a/General/HowToCompileWithUbuntuInDocker.md b/General/HowToCompileWithUbuntuInDocker.md
index 6ecaddbb..fae1c35c 100644
--- a/General/HowToCompileWithUbuntuInDocker.md
+++ b/General/HowToCompileWithUbuntuInDocker.md
@@ -1,10 +1,10 @@
-# How to compile with Ubuntu in Docker
+# How to compile with Ubuntu in Docker
## 1. Overview
- [Docker](https://www.docker.com/) is useful for the easy setup of the compile environment for S2E.
- *Both Windows and Mac* users can use the same environment and get the same result by using the docker container.
-- We selected [Ubuntu](https://ubuntu.com/) as an OS in the docker image and [GCC/G++](https://gcc.gnu.org/) as a compiler for S2E.
- **Note**: Currently, we use a 32bit compiler for S2E since flight S/Ws are usually executed on a 32bit microcomputers.
+- We selected [Ubuntu](https://ubuntu.com/) as an OS in the docker image and [GCC/G++](https://gcc.gnu.org/) as a compiler for S2E.
+ **Note**: Currently, we use a 32bit compiler for S2E since flight S/Ws are usually executed on a 32bit microcomputers.
- We recommend using [Visual Studio Code](https://code.visualstudio.com/) as an editor for the environment.
- This document explains a setup sequence of the docker environment for S2E.
@@ -22,44 +22,44 @@
- CMake Tools
- C/C++
- Following extensions are also useful
- - Markdown+Math
+ - Markdown+Math
please change the delimiter setting to use the same math format with `Gitlab`.
- Code Spell Checker
### 2.3. **For Mac users**
- Install `coreutils` to use `realpath` command in `setup_docker.sh`
-- Use the `brew install coreutils` command when you have `Homebrew`
+- Use the `brew install coreutils` command when you have `Homebrew`
## 3. A Sequence of environment setting
### 3.1. Working directory setting
- Create `work` directory as a working directory.
- Clone [s2e-core](https://github.com/ut-issl/s2e-core) in the `work` directory.
-- Add the `work` directory in the `file sharing` directory of Docker.
+- Add the `work` directory in the `file sharing` directory of Docker.
**Note**: This setting does not exist in the latest Docker and WSL2 environments in Windows, so it is not necessary.
### 3.2. Make Docker image and container
-- Launch `git bush` (for windows users) or `terminal` (for Mac users)
+- Launch `git bash` (for windows users) or `terminal` (for Mac users)
- Move `/s2e-core/scripts/Docker_Ubuntu` directory
- Edit `Dockerfile` or `setup_docker.sh` when you want to change the directory name, the user name of the container, and other settings.
- Execute `./setup_docker.sh build` to make images
-- Check created image (`issl` (and `ubuntu`))
+- Check created image (`issl` (and `ubuntu`))
command: `docker images`
- Execute `./setup_docker.sh run_core` to make a container
-- Check created container (`issl:latest`)
+- Check created container (`issl:latest`)
command: `docker ps -a`
-- Check dashboard of Docker
+- Check dashboard of Docker
### 3.3. SSH connect with VS Code
- Launch `VS Code` and open new window
-- Click the `Remote Explorer` icon on the left side
+- Click the `Remote Explorer` icon on the left side
Note: the icon looks like a monitor
-- Click the `gear` icon of `SSH TARGETS` and select the config file you want to edit
+- Click the `gear` icon of `SSH TARGETS` and select the config file you want to edit
Default: `C:\Users\UserName\ssh\config` or `User/UserName/ssh/config`
- Edit the config file as follows
-```
+```
Host issl-1
HostName localhost
User s2e
@@ -79,21 +79,21 @@ Host issl-1
- S2E has several script files to get external libraries.
- For this ubuntu/docker platform, users should use script files in `scripts/Common` directory and `scripts/Docker_Ubuntu` directory.
-- Users can execute most of the script files with `git bush` or `terminal` in the outside of the container, but users should execute `scripts/Common/download_nrlmsise00_src_and_table.sh` inside the container to use the same compiler.
+- Users can execute most of the script files with `git bash` or `terminal` in the outside of the container, but users should execute `scripts/Common/download_nrlmsise00_src_and_table.sh` inside the container to use the same compiler.
- Click `Terminal > New terminal` in the menu bar of VS Code
- Select `bash` terminal at the bottom window
- execute `./s2e-core/scripts/Common/download_nrlmsise00_src_and_table.sh`
- See `ExtLibraries` to confirm the NRLMSISE library is generated.
-
+
### 3.5. Build S2E
-- Install following extensions in the `issl-1 SSH connection`
+- Install following extensions in the `issl-1 SSH connection`
Even if the extensions were already installed in local VS code, you also need to install them in the `SSH connection`
- C/C++
- CMake
- - CMake Tools
+ - CMake Tools
**Note** : You need to reload VS Code after installing new extensions
-- Edit setting of `CMake Tools` in `issl-1`
+- Edit setting of `CMake Tools` in `issl-1`
`Cmake Build Directory: ${workspaceFolder}/s2e-core/build/Debug`
- After `CMake` and `CMake Tools` are installed, VS Code requires you to configure the build environment with `CMakeList.txt`. Please select `yes`. But there is no `CMakeList.txt` file in the `work` directory, and VS Code requires you to locate `CMakeList.txt`, so please select the `CMakeList.txt` file in `s2e-core` directory.
- This setting is written in `.vscode/settings.json`
@@ -104,7 +104,7 @@ Host issl-1
"cmake.buildDirectory": "${workspaceFolder}/s2e-core/build/Debug"
}
```
-- Select `GCC 9.3.0` as a kit (compiler)
+- Select `GCC 9.3.0` as a kit (compiler)
- Select `CMake [Debug]` and check the configuration is successfully done.
- Build S2E
- If you want clean up, please use `CMake: Clean` command
@@ -114,7 +114,7 @@ Host issl-1
## 4. Debug with VS Code
- Select `Run > Start Debugging` in the menu bar.
-- Select `C++(GDB/LLDB)` debugger
+- Select `C++(GDB/LLDB)` debugger
`.vscode/launch.json` will be created.
- Edit as follows
```json
From c091abd3e640dd03811f36a3af625b2252166b67 Mon Sep 17 00:00:00 2001
From: Masahiro Fujiwara <38275468+mfuji074@users.noreply.github.com>
Date: Wed, 19 Jan 2022 22:30:40 +0900
Subject: [PATCH 2/2] undo whitespace changes
---
General/HowToCompileWithUbuntuInDocker.md | 37 +++++++++++------------
1 file changed, 18 insertions(+), 19 deletions(-)
diff --git a/General/HowToCompileWithUbuntuInDocker.md b/General/HowToCompileWithUbuntuInDocker.md
index fae1c35c..d93216ff 100644
--- a/General/HowToCompileWithUbuntuInDocker.md
+++ b/General/HowToCompileWithUbuntuInDocker.md
@@ -1,10 +1,10 @@
-# How to compile with Ubuntu in Docker
+# How to compile with Ubuntu in Docker
## 1. Overview
- [Docker](https://www.docker.com/) is useful for the easy setup of the compile environment for S2E.
- *Both Windows and Mac* users can use the same environment and get the same result by using the docker container.
-- We selected [Ubuntu](https://ubuntu.com/) as an OS in the docker image and [GCC/G++](https://gcc.gnu.org/) as a compiler for S2E.
- **Note**: Currently, we use a 32bit compiler for S2E since flight S/Ws are usually executed on a 32bit microcomputers.
+- We selected [Ubuntu](https://ubuntu.com/) as an OS in the docker image and [GCC/G++](https://gcc.gnu.org/) as a compiler for S2E.
+ **Note**: Currently, we use a 32bit compiler for S2E since flight S/Ws are usually executed on a 32bit microcomputers.
- We recommend using [Visual Studio Code](https://code.visualstudio.com/) as an editor for the environment.
- This document explains a setup sequence of the docker environment for S2E.
@@ -22,19 +22,19 @@
- CMake Tools
- C/C++
- Following extensions are also useful
- - Markdown+Math
+ - Markdown+Math
please change the delimiter setting to use the same math format with `Gitlab`.
- Code Spell Checker
### 2.3. **For Mac users**
- Install `coreutils` to use `realpath` command in `setup_docker.sh`
-- Use the `brew install coreutils` command when you have `Homebrew`
+- Use the `brew install coreutils` command when you have `Homebrew`
## 3. A Sequence of environment setting
### 3.1. Working directory setting
- Create `work` directory as a working directory.
- Clone [s2e-core](https://github.com/ut-issl/s2e-core) in the `work` directory.
-- Add the `work` directory in the `file sharing` directory of Docker.
+- Add the `work` directory in the `file sharing` directory of Docker.
**Note**: This setting does not exist in the latest Docker and WSL2 environments in Windows, so it is not necessary.
### 3.2. Make Docker image and container
@@ -42,24 +42,24 @@
- Move `/s2e-core/scripts/Docker_Ubuntu` directory
- Edit `Dockerfile` or `setup_docker.sh` when you want to change the directory name, the user name of the container, and other settings.
- Execute `./setup_docker.sh build` to make images
-- Check created image (`issl` (and `ubuntu`))
+- Check created image (`issl` (and `ubuntu`))
command: `docker images`
- Execute `./setup_docker.sh run_core` to make a container
-- Check created container (`issl:latest`)
+- Check created container (`issl:latest`)
command: `docker ps -a`
-- Check dashboard of Docker
+- Check dashboard of Docker
### 3.3. SSH connect with VS Code
- Launch `VS Code` and open new window
-- Click the `Remote Explorer` icon on the left side
+- Click the `Remote Explorer` icon on the left side
Note: the icon looks like a monitor
-- Click the `gear` icon of `SSH TARGETS` and select the config file you want to edit
+- Click the `gear` icon of `SSH TARGETS` and select the config file you want to edit
Default: `C:\Users\UserName\ssh\config` or `User/UserName/ssh/config`
- Edit the config file as follows
-```
+```
Host issl-1
HostName localhost
User s2e
@@ -84,16 +84,16 @@ Host issl-1
- Select `bash` terminal at the bottom window
- execute `./s2e-core/scripts/Common/download_nrlmsise00_src_and_table.sh`
- See `ExtLibraries` to confirm the NRLMSISE library is generated.
-
+
### 3.5. Build S2E
-- Install following extensions in the `issl-1 SSH connection`
+- Install following extensions in the `issl-1 SSH connection`
Even if the extensions were already installed in local VS code, you also need to install them in the `SSH connection`
- C/C++
- CMake
- - CMake Tools
+ - CMake Tools
**Note** : You need to reload VS Code after installing new extensions
-- Edit setting of `CMake Tools` in `issl-1`
+- Edit setting of `CMake Tools` in `issl-1`
`Cmake Build Directory: ${workspaceFolder}/s2e-core/build/Debug`
- After `CMake` and `CMake Tools` are installed, VS Code requires you to configure the build environment with `CMakeList.txt`. Please select `yes`. But there is no `CMakeList.txt` file in the `work` directory, and VS Code requires you to locate `CMakeList.txt`, so please select the `CMakeList.txt` file in `s2e-core` directory.
- This setting is written in `.vscode/settings.json`
@@ -104,7 +104,7 @@ Host issl-1
"cmake.buildDirectory": "${workspaceFolder}/s2e-core/build/Debug"
}
```
-- Select `GCC 9.3.0` as a kit (compiler)
+- Select `GCC 9.3.0` as a kit (compiler)
- Select `CMake [Debug]` and check the configuration is successfully done.
- Build S2E
- If you want clean up, please use `CMake: Clean` command
@@ -114,12 +114,11 @@ Host issl-1
## 4. Debug with VS Code
- Select `Run > Start Debugging` in the menu bar.
-- Select `C++(GDB/LLDB)` debugger
+- Select `C++(GDB/LLDB)` debugger
`.vscode/launch.json` will be created.
- Edit as follows
```json
"program": "${workspaceFolder}/s2e-core/build/Debug/S2E",
-
"cwd": "${workspaceFolder}/s2e-core/build/Debug",
```
- Select `Run > Start Debugging` again
