Skip to content

Commit f7903b5

Browse files
committed
Fix README.md. Change folder organization.
1 parent b8ab517 commit f7903b5

File tree

3 files changed

+29
-26
lines changed

3 files changed

+29
-26
lines changed

README.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
This repository "Software Verification" course at the Faculty of Mathematics in Belgrade.
44

55
Techniques and tools used:
6-
- Unit testing via [twister]() tool
7-
-
6+
- Unit testing via [twister](https://docs.zephyrproject.org/3.1.0/develop/test/twister.html) tool
7+
- Valgrind memcheck
8+
- Static analysis
9+
- Adress sanitizer
810

911
Repo organization:
1012

@@ -21,35 +23,43 @@ Repo organization:
2123

2224
Zephyr-project's west tool is used for updating the zephyr repository, building, flashing zephyr apps etc. It can be installed using following commands:
2325

24-
```pip3 install --user -U west
26+
```
27+
pip3 install --user -U west
2528
echo 'export PATH=~/.local/bin:"$PATH"' >> ~/.bashrc
2629
source ~/.bashrc
2730
```
2831

2932
#### Install additional requirements
3033

31-
`cd zephyr`
32-
`pip3 install --user -r scripts/requirements.txt`
34+
```
35+
cd zephyr
36+
pip3 install --user -r scripts/requirements.txt
37+
```
3338

3439
### Install the zephyr SDK
3540

3641
In order to use all of the required tools for testing and building zephyr applications, SDK is needed. It can be downloaded using following commands:
3742

3843
#### Set up the environment for SDK installation
3944

40-
`export ZEPHYR_TOOLCHAIN_VARIANT=zephyr`
41-
`export ZEPHYR_SDK_INSTALL_DIR=/opt/zephyr-sdk`
42-
`. ./zephyr-env.sh`
45+
```
46+
export ZEPHYR_TOOLCHAIN_VARIANT=zephyr
47+
export ZEPHYR_SDK_INSTALL_DIR=/opt/zephyr-sdk
48+
. ./zephyr-env.sh
49+
```
4350

4451
#### Download and install the SDK
4552

46-
`cd ~`
47-
`wget https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.16.0/zephyr-sdk-0.16.0_linux-x86_64.tar.xz`
48-
`wget -O - https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.16.0/sha256.sum | shasum --check --ignore-missing`
53+
```
54+
cd ~
55+
wget https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.16.0/zephyr-sdk-0.16.0_linux-x86_64.tar.xz
56+
wget -O - https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v0.16.0/sha256.sum | shasum --check --ignore-missing
57+
```
4958

5059
Extract and install the SDK:
5160

52-
`tar xvf zephyr-sdk-0.16.0_linux-x86_64.tar.xz`
53-
54-
`cd zephyr-sdk-0.16.0`
55-
`./setup.sh`
61+
```
62+
tar xvf zephyr-sdk-0.16.0_linux-x86_64.tar.xz
63+
cd zephyr-sdk-0.16.0
64+
./setup.sh
65+
```

twister_reports/README.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

unit_testing/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ ZTEST(math_extras_portable, test_portable_u32_add) {
3333

3434
Twister command for running the tests:
3535

36-
`west twister --coverage -p unit_testing -T tests/unit/math_extras/ -v --report-dir ~/2023_Analysis_zephyr/twister_reports/test_coverage/unit_run_math_extras --outdir ~/2023_Analysis_zephyr/twister_reports/test_coverage/math_extras/unit_run_math_extras`
36+
```
37+
west twister --coverage -p unit_testing -T tests/unit/math_extras/ -v --report-dir ~/2023_Analysis_zephyr/twister_reports/test_coverage/unit_run_math_extras --outdir ~/2023_Analysis_zephyr/twister_reports/test_coverage/math_extras/unit_run_math_extras
38+
```
3739

3840
*NOTE*: As mentioned, `CMakeLists.txt` was modified between two runs. This was done to test math_extras functions with and without builtin support.
3941

@@ -84,7 +86,7 @@ means that Twister will call `math_extras.test_u32_add` test case during executi
8486

8587
lcov is a tool that creates graphical representation of the code coverage in .html format. Reports for math_extras functions are given below:
8688

87-
![code coverage report](./test_coverage/mat_extras/lcov_math_extras_report.png "lcov report").
89+
![code coverage report](./test_coverage/math_extras/lcov_math_extras_report.png "lcov report").
8890

8991

9092
As the reports show, there is a 100% coverage of the `math_extras` functions both with builtin functions and with portable implementation.

0 commit comments

Comments
 (0)