summaryrefslogtreecommitdiff
path: root/bin
diff options
context:
space:
mode:
authorDaniel Friesel <daniel.friesel@uos.de>2021-10-05 08:00:09 +0200
committerDaniel Friesel <daniel.friesel@uos.de>2021-10-05 08:00:09 +0200
commitf460374f7c9c65e02480453ee9a79c93fc499a77 (patch)
tree4e90a8bd35bdaf7386037a5ce79e9f522facfe92 /bin
parent102bc4c22d57a6fc7d7c353d9b5251b0c8c3e768 (diff)
explore-config: documentation
Diffstat (limited to 'bin')
-rwxr-xr-xbin/explore-kconfig.py8
1 files changed, 6 insertions, 2 deletions
diff --git a/bin/explore-kconfig.py b/bin/explore-kconfig.py
index d941176..c1152ba 100755
--- a/bin/explore-kconfig.py
+++ b/bin/explore-kconfig.py
@@ -4,12 +4,16 @@
explore-kconfig obtains build attributes such as ROM or RAM usage of
configuration variants for a given software project. It works on random
-random configurations (--random) or in the neighbourhood
-of existing configurations (--neighbourhood).
+configurations (--random) or in the neighbourhood of existing configurations
+(--neighbourhood).
Supported projects must be configurable via kconfig and provide a command which
outputs a JSON dict of build attributes on stdout. Use
--{clean,build,attribute}-command to configure explore-kconfig for a project.
+
+explore-kconfig places the experiment results (containing configurations, build
+logs, and correspondnig attributes) in the current working directory. Use
+analyze-kconfig to build a model once data acquisition is complete.
"""
import argparse