From 6ed6dda627a629a47ce67497253f8b0e268eb494 Mon Sep 17 00:00:00 2001 From: Lukas Rothenberger Date: Wed, 10 Jan 2024 09:33:01 +0100 Subject: [PATCH] doc(wiki)[tools]: config provider --- docs/tools/Config_provider.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/tools/Config_provider.md b/docs/tools/Config_provider.md index 5e69dcc7a..2347ff54c 100644 --- a/docs/tools/Config_provider.md +++ b/docs/tools/Config_provider.md @@ -5,4 +5,20 @@ parent: Tools nav_order: 6 --- -TODO \ No newline at end of file +# 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 +``` \ No newline at end of file