Skip to content

Commit 5cbb0fd

Browse files
doc: release preparation
1 parent c04ebb5 commit 5cbb0fd

File tree

5 files changed

+26
-15
lines changed

5 files changed

+26
-15
lines changed

DEBIAN/postinst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ LLVM_DIR=${DP_BUILD_DIR}/third_party/llvm-11.1.0
1818
echo "Building DiscoPoP"
1919
cd ${DP_BUILD_DIR}
2020
cmake .. -DLLVM_DIST_PATH=${LLVM_DIR} -DIS_DEB_INSTALL="TRUE" -DDP_PTHREAD_COMPATIBILITY_MODE=0 -DDP_NUM_WORKERS=8 -DDP_RTLIB_VERBOSE=0 -DDP_MEMORY_REGION_DEALIASING=0 -DDP_BRANCH_TRACKING=0 -DDP_CALLSTACK_PROFILING=0 -DDP_STACK_ACCESS_DETECTION=0 -DDP_CALLSTACK_PROFILING_ENABLE_CUTOFF=1 -DDP_INTERNAL_TIMER=0 -DDP_HYBRID_PROFILING=1 -DDP_HYBRID_PROFILING_CUTOFF=0 -DDP_HYBRID_PROFILING_CUTOFF_IGNORE_PROBABILITY=1 -DDP_PROFILING_SAMPLING_PROBABILITY=0 -DDP_CALLTREE_PROFILING=1 -DDP_CALLTREE_PROFILING_METADATA_CUTOFF=5 -DDP_CALLTREE_PROFILING_METADATA_CUTOFF_IGNORE_PROBABILITY=1
21-
make -j
21+
make -j 4
2222

2323
chmod -R 777 ${DP_DIR}
2424

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,25 @@ For a brief introduction to the command line tools, please refer to the [tools o
3434
For detailed information on the gathered and stored data as well as the tools themselves, please refer to [data](https://discopop-project.github.io/discopop/Data) and the pages of the individual tools in the [tools overview](https://discopop-project.github.io/discopop/Tools).
3535

3636
## TL;DR
37-
This example installs DiscoPoP, instruments and builds the provided example, analyzes the results, and prints the identified parallelization suggestions to the console.
37+
If you are interested in installing DiscoPoP as a `developer`, please refer to the [DiscoPoP setup wiki page](https://discopop-project.github.io/discopop/setup/discopop/).
38+
39+
The following example installs DiscoPoP for `users`, instruments and builds the provided example, analyzes the results, and prints the identified parallelization suggestions to the console.
3840
In case any issues arise during the process, please refer to the detailed [setup instructions](https://discopop-project.github.io/discopop/Setup), contact us via GitHub messages, or get in contact by mail to [discopop-support@lists.parallel.informatik.tu-darmstadt.de](mailto:discopop-support@lists.parallel.informatik.tu-darmstadt.de).
41+
42+
### Prerequisites
43+
- Download `.deb` package from [latest Release](https://github.com/discopop-project/discopop/releases/latest)
44+
### Example
3945
```
40-
# setup DiscoPoP
41-
git clone git@github.com:discopop-project/discopop.git
42-
cd discopop
43-
mkdir build && cd build
44-
DP_BUILD=$(pwd)
45-
cmake .. && make
46+
# install package
47+
sudo apt install ./<packagename>.deb
4648
# instrument and build the example code
47-
cd ../example
48-
mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=${DP_BUILD}/scripts/CXX_wrapper.sh .. && make
49+
cd /opt/DiscoPoP/example
50+
mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=discopop_cxx .. && make
4951
# execute instrumented code
5052
./cmake_example
5153
# identify parallel patterns
5254
cd .discopop
5355
discopop_explorer
54-
# create applicable patches from patterns
55-
discopop_patch_generator
5656
# print patches to the console
5757
for f in $(find patch_generator -maxdepth 1 -type d); do
5858
echo "SUGGESTION: $f"
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
4.0.0
1+
4.0.1

docs/setup/discopop.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,16 @@ parent: Setup
55
nav_order: 1
66
---
77

8-
# DiscoPoP Setup
8+
# DiscoPoP Setup - Package
9+
- Proposed method of installation for `users` of DiscoPoP
10+
- Download the `.deb` package of choice from [releases](https://github.com/discopop-project/discopop/releases).
11+
- Packages for different targets and configurations might become available in the future
12+
- Install via a package manager of choice (example: `sudo apt install ./<packagename>.deb`)
13+
- Uninstall via a package manager of choice (example: `sudo apt remove discopop`)
14+
15+
16+
# DiscoPoP Setup - Manual
17+
- Proposed method of installation for `developers` of DiscoPoP
918
## Prerequisites
1019
- LLVM/clang version 11
1120
- Python version 3.6 or greater
@@ -47,5 +56,6 @@ where `<CMAKE_FLAGS>` can consist of any combination of the following flags and
4756
## Testing the installation
4857
To test the installation, it is possible to execute the provided set of unit tests.
4958
```
50-
python -m unittest -v
59+
cd <dp_source_dir>
60+
venv/bin/python -m unittest -v
5161
```
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1 /home/lukas/git/discopop/test/end_to_end/do_all/calls/second_order/preventing_2/src/code.cpp

0 commit comments

Comments
 (0)