Skip to content

Commit

Permalink
doc: release preparation
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasrothenberger committed Nov 14, 2024
1 parent c04ebb5 commit 5cbb0fd
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 15 deletions.
2 changes: 1 addition & 1 deletion DEBIAN/postinst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ LLVM_DIR=${DP_BUILD_DIR}/third_party/llvm-11.1.0
echo "Building DiscoPoP"
cd ${DP_BUILD_DIR}
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
make -j
make -j 4

chmod -R 777 ${DP_DIR}

Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,25 +34,25 @@ For a brief introduction to the command line tools, please refer to the [tools o
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).

## TL;DR
This example installs DiscoPoP, instruments and builds the provided example, analyzes the results, and prints the identified parallelization suggestions to the console.
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/).

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.
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 [[email protected]](mailto:[email protected]).

### Prerequisites
- Download `.deb` package from [latest Release](https://github.com/discopop-project/discopop/releases/latest)
### Example
```
# setup DiscoPoP
git clone [email protected]:discopop-project/discopop.git
cd discopop
mkdir build && cd build
DP_BUILD=$(pwd)
cmake .. && make
# install package
sudo apt install ./<packagename>.deb
# instrument and build the example code
cd ../example
mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=${DP_BUILD}/scripts/CXX_wrapper.sh .. && make
cd /opt/DiscoPoP/example
mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=discopop_cxx .. && make
# execute instrumented code
./cmake_example
# identify parallel patterns
cd .discopop
discopop_explorer
# create applicable patches from patterns
discopop_patch_generator
# print patches to the console
for f in $(find patch_generator -maxdepth 1 -type d); do
echo "SUGGESTION: $f"
Expand Down
2 changes: 1 addition & 1 deletion discopop_library/global_data/version/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4.0.0
4.0.1
14 changes: 12 additions & 2 deletions docs/setup/discopop.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,16 @@ parent: Setup
nav_order: 1
---

# DiscoPoP Setup
# DiscoPoP Setup - Package
- Proposed method of installation for `users` of DiscoPoP
- Download the `.deb` package of choice from [releases](https://github.com/discopop-project/discopop/releases).
- Packages for different targets and configurations might become available in the future
- Install via a package manager of choice (example: `sudo apt install ./<packagename>.deb`)
- Uninstall via a package manager of choice (example: `sudo apt remove discopop`)


# DiscoPoP Setup - Manual
- Proposed method of installation for `developers` of DiscoPoP
## Prerequisites
- LLVM/clang version 11
- Python version 3.6 or greater
Expand Down Expand Up @@ -47,5 +56,6 @@ where `<CMAKE_FLAGS>` can consist of any combination of the following flags and
## Testing the installation
To test the installation, it is possible to execute the provided set of unit tests.
```
python -m unittest -v
cd <dp_source_dir>
venv/bin/python -m unittest -v
```
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1 /home/lukas/git/discopop/test/end_to_end/do_all/calls/second_order/preventing_2/src/code.cpp

0 comments on commit 5cbb0fd

Please sign in to comment.