From 0fcfe899425a3d857cfca4895564e82a3f4f0fb2 Mon Sep 17 00:00:00 2001
From: Jason Albert <albertj@us.ibm.com>
Date: Tue, 30 Aug 2016 14:59:38 -0500
Subject: Renamed file to have .md extension

---
 docs/xmlformat.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 docs/xmlformat.md

(limited to 'docs/xmlformat.md')

diff --git a/docs/xmlformat.md b/docs/xmlformat.md
new file mode 100644
index 0000000..b442458
--- /dev/null
+++ b/docs/xmlformat.md
@@ -0,0 +1,31 @@
+## Introduction
+
+This file will describe the xml of the vpd template file format used to
+describe the contents of a VPD image
+
+## High Level Description
+
+The template VPD format is XML, used to describe the contents of a binary VPD image.  The template file is fed into createVpd.py.  It in turn interprets that XML, error checks it and creates a binary VPD image.
+
+The template consists of 3 levels
+* `<vpd>` - information about the overall VPD image
+* `<record>` - information about a record in `<vpd>`
+* `<keyword>` - information about a keyword contained in a `<record>`
+
+The XML Hierarchy looks like the following:
+``` xml
+<vpd>
+  <record>
+    <keyword>
+    </keyword>
+    <keyword>
+    </keyword>
+  </record>
+  <record>
+    <keyword>
+    ..
+  </record>
+  <record>
+  ..
+</vpd>
+```
\ No newline at end of file
-- 
cgit v1.2.3