Skip to content

Commit

Permalink
doc(wiki)[tools]: config provider
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasrothenberger committed Jan 10, 2024
1 parent b0b5d70 commit 6ed6dda
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/tools/Config_provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,20 @@ parent: Tools
nav_order: 6
---

TODO
# Config provied
## Executable
`discopop_config_provider`

## Purpose
The config provider acts a simple and globally accessible way to retrieve information regarding the local DiscoPoP installation.
Values which can obtained via the config provider are for example the paths to the `discopop build directory`, the `discopop source directory`, or the `llvm binary directory`.


## Output
The requested values are simply returned in the form of a string if the python module is imported, or printed to `stdout` in case of a standalone invokation.

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

0 comments on commit 6ed6dda

Please sign in to comment.