some more documentation cleanup

1 files changed, 7 insertions, 0 deletions

diff --git a/doc/analysis-logs.md b/doc/analysis-logs.md
new file mode 100644
index 0000000..f787a18
--- /dev/null
+++ b/doc/analysis-logs.md
@@ -0,0 +1,7 @@
+# Data Analysis and Performance Model Generation from Log Files
+
+Here, dfatool works with lines of the form "`[::]` *Key* *Attribute* | *parameters* | *NFP values*", where *parameters* is a space-separated series of *param=value* entries (i.e., benchmark configuration) and *NFP values* is a space-separate series of *NFP=value* entries (i.e., benchmark output).
+All measurements of a given *Key* *Attribute* combination must use the same set of NFP names.
+Parameter names may be different -- parameters that are present in other lines of the same *Key* *Attribute* will be treated as undefined in those lines where they are missing.
+
+Use `bin/analyze-log.py file1.txt file2.txt ...` for analysis.