Skip to content

Commit

Permalink
doc(wiki)[tools]: patch generator
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasrothenberger committed Jan 10, 2024
1 parent 60b0b4e commit b3d04d2
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion docs/tools/Patch_generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,25 @@ parent: Tools
nav_order: 3
---

TODO
# DiscoPoP patch generator
## Executable
`discopop_patch_generator`

## Purpose
Convert a set of parallel patterns obtained by the [DiscoPoP Explorer](../tools/Explorer.md) or [optimizer](../tools/Optimizer.md) into a structured set of applicable patch files.
The created patches can be applied manually or via the [DiscoPoP patch applicator](../tools/Patch_applicator.md).

## Required input
- `Parallel patterns` in the form of a `JSON` file

## Output
The created patches will be stored in a folder named `.discopop/patch_generator`.
Within this folder, individual folders for each parallel pattern will be created. Their `id` will act as the folders name.
Within these inner folders, patch files for all modified `file-id` are created.
Please refer to [Filemapping](../data/Filemapping.md) for information how to interpre the used `file-ids`.

## Note
For a more detailed description of the available run-time arguments, please refer to the help string of the respective tool.
```
discopop_patch_generator --help
```

0 comments on commit b3d04d2

Please sign in to comment.