diff options
| author | Jason Albert <albertj@us.ibm.com> | 2016-08-30 15:03:01 -0500 |
|---|---|---|
| committer | Jason Albert <albertj@us.ibm.com> | 2016-08-30 15:03:01 -0500 |
| commit | dd64fb3be86ec646ec02865744a3fac4813600db (patch) | |
| tree | 02c191375ee6daf6fc7b4e2c521df0de44eb9a49 /docs | |
| parent | 0fcfe899425a3d857cfca4895564e82a3f4f0fb2 (diff) | |
| download | vpdtools-dd64fb3be86ec646ec02865744a3fac4813600db.tar.gz vpdtools-dd64fb3be86ec646ec02865744a3fac4813600db.zip | |
Added section on <vpd> tag
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/xmlformat.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/xmlformat.md b/docs/xmlformat.md index b442458..9ca7ba7 100644 --- a/docs/xmlformat.md +++ b/docs/xmlformat.md @@ -28,4 +28,50 @@ The XML Hierarchy looks like the following: <record> .. </vpd> +``` + +## `<vpd>` +This section covers the required tags in the <vpd> section of the template description + +The top level `<vpd>` tag is required in all template files, whether it is a top level manifest description of a full image or simply a record level description. The tag requirements in the <vpd> section depend upon usage. + +### Tags included in the `<vpd>` +`<name></name>` +Used to define the output name of the files created by the tool. This information is not stuck into the binary VPD image. + +If the special name of FILENAME is given, then the name of the top level manifest file will be used for the name on any output files. + +Can be used only once in the top level description +Cannot be included in single record definitions + +`<size></size>` +Used to define the maximum size of the binary image. If the create image will exceede this size, an error is generated by the tool. + +Can be used only once in the top level description +Cannot be included in single record definitions + +`<VD></VD>` +The hex value to be stuck in for the VD keyword in the VHDR + +Can be used only once in the top level description +Cannot be included in single record definitions + +``` xml +<record> + .. +</record> +``` +Defines the creation of a record within VPD. Please see the section on the `<record>` tag for more information on valid fields and syntax + +When creating a top level VPD template, at least 1 `<record>` must be defined. +When creating a record only template description, only 1 `<record>` tag can be used. It is not allowed to include different records in a record only template. + +A sample `<vpd>` section would look like this: +``` xml +<vpd> + <name>simple</name> + <size>16kb</size> + <VD>01</VD> + <record ..> +</vpd> ```
\ No newline at end of file |
