[PATCH] Add README_JSON.txt for FWTS
Deb McLemore
debmc at linux.vnet.ibm.com
Thu Feb 2 14:44:36 UTC 2017
Adding a README to document how the olog.json file is automatically
generated and maintained.
Signed-off-by: Deb McLemore <debmc at linux.vnet.ibm.com>
---
data/README_JSON.txt | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
create mode 100644 data/README_JSON.txt
diff --git a/data/README_JSON.txt b/data/README_JSON.txt
new file mode 100644
index 0000000..52bb246
--- /dev/null
+++ b/data/README_JSON.txt
@@ -0,0 +1,26 @@
+README for JSON files for the FirmWare Test Suite (fwts)
+========================================================
+
+Special considerations for the JSON files:
+
+olog.json
+
+olog.json is automatically generated with a tool from the
+skiboot git source:
+
+git clone git://github.com/open-power/skiboot.git
+cd skiboot
+./external/fwts/generate-fwts-olog --output olog.json
+
+If any changes are requested in the format or typos for olog.json,
+please pursue the skiboot source as the mechanism for updating,
+i.e. contact the skiboot maintainers to make the source code
+change and then once the change is merged to the git tree then
+the above tool can be used to generate a new olog.json file
+which can then be submitted as the fwts source change.
+
+The olog.json file is periodically submitted to fwts to refresh
+the data based on the current skiboot source tree.
+
+To contact the skiboot maintainers:
+skiboot at lists.ozlabs.org
--
2.7.4
More information about the fwts-devel
mailing list