IntelFsp2Pkg/Tools/UserManuals/FspDscBsf2YamlUserManual.md

   1 #Name
   2 **FspDscBsf2Yaml.py** The python script that generates YAML file for
   3 the Boot Settings from an EDK II Platform Description (**DSC**) file
   4 or from a Boot Settings File (**BSF**). It is created to help
   5 transitioning FSP Updateable Product Data (**UPD**) file format to
   6 new standardized YAML format so that it can be configured through
   7 open source tools.
   8
   9 #Synopsis
  10 ```
  11 FspDscBsf2Yaml DscFile|BsfFile  YamlFile
  12 ```
  13
  14 #Description
  15 **FspDscBsf2Yaml.py** is a script that generates configuration options from an
  16 **EDK II Platform Description (DSC)** file or **a Boot Settings File (BSF)** file.
  17
  18 It generates a **YAML file** that can be used by the **Config Editor** to provide
  19 a graphical user interface for manipulating settings in the UPD regions.
  20
  21 The following sections explain the usage of this script.
  22
  23 ## 1. FspDscBsf2Yaml.py DscFile YamlFile
  24
  25 The **DscFile** option is an input DSC file.
  26
  27 The **YamlFile** option is an output YAML file.
  28
  29 The script takes the FSP DSC file consisting BSF syntax and generates a YAML
  30 output file describing the boot settings.
  31
  32 ## 2. FspDscBsf2Yaml.py BsfFile YamlFile
  33
  34 The **BsfFile** option is an input BSF file.
  35
  36 The **YamlFile** option is an output YAML file.
  37
  38 The script generates a YAML output file from a BSF file. The BSF file
  39 can be generated using GenCfgOpt tool.