[mirror_edk2.git] / IntelFsp2Pkg / Tools / UserManuals / ConfigEditorUserManual.md

#Name\r
**ConfigEditor.py** is a python script with a GUI interface that can support changing configuration settings directly from the interface without having to modify the source.\r
\r
#Description\r
This is a GUI interface that can be used by users who would like to change configuration settings directly from the interface without having to modify the SBL source.\r
This tool depends on Python GUI tool kit Tkinter. It runs on both Windows and Linux.\r
The user needs to load the YAML file along with DLT file for a specific board into the ConfigEditor, change the desired configuration values. Finally, generate a new configuration delta file or a config binary blob for the newly changed values to take effect. These will be the inputs to the merge tool or the stitch tool so that new config changes can be merged and stitched into the final configuration blob.\r
\r
\r
It supports the following options:\r
\r
## 1. Open Config YAML file\r
This option loads the YAML file for a FSP UPD into the ConfigEditor to change the desired configuration values.\r
\r
#####Example:\r
```\r
![Example ConfigEditor 1](https://slimbootloader.github.io/_images/CfgEditOpen.png)\r
\r
![Example ConfigEditor 2](https://slimbootloader.github.io/_images/CfgEditDefYaml.png)\r
```\r
\r
## 2. Open Config BSF file\r
This option loads the BSF file for a FSP UPD into the ConfigEditor to change the desired configuration values. It works as a similar fashion with Binary Configuration Tool (BCT)\r
\r
## 3. Show Binary Information\r
This option loads configuration data from FD file and displays it in the ConfigEditor.\r
\r
## 4. Save Config Data to Binary\r
This option generates a config binary blob for the newly changed values to take effect.\r
\r
## 5. Load Config Data from Binary\r
This option reloads changed configuration from BIN file into the ConfigEditor.\r
\r
## 6. Load Config Changes from Delta File\r
This option loads the changed configuration values from Delta file into the ConfigEditor.\r
\r
## 7. Save Config Changes to Delta File\r
This option generates a new configuration delta file for the newly changed values to take effect.\r
\r
## 8. Save Full Config Data to Delta File\r
This option saves all the changed configuration values into a Delta file.\r
\r
## 9. Search feature\r
This feature helps the user to easily find any configuration item they are looking for in ConfigEditor.\r
A text search box is available on the Top Right Corner of ConfigEditor. To use this feature the user should type the name or a key word of the item they want to search in the text box and then click on the "Search" button. This will display all the items which contains that particular word searched by the user.\r
\r
## Running Configuration Editor:\r
\r
   **python ConfigEditor.py**\r
Commit	Line	Data
580b1120 LTL	1	#Name\r
	2	ConfigEditor.py is a python script with a GUI interface that can support changing configuration settings directly from the interface without having to modify the source.\r
	3	\r
	4	#Description\r
	5	This is a GUI interface that can be used by users who would like to change configuration settings directly from the interface without having to modify the SBL source.\r
	6	This tool depends on Python GUI tool kit Tkinter. It runs on both Windows and Linux.\r
	7	The user needs to load the YAML file along with DLT file for a specific board into the ConfigEditor, change the desired configuration values. Finally, generate a new configuration delta file or a config binary blob for the newly changed values to take effect. These will be the inputs to the merge tool or the stitch tool so that new config changes can be merged and stitched into the final configuration blob.\r
	8	\r
	9	\r
	10	It supports the following options:\r
	11	\r
	12	## 1. Open Config YAML file\r
	13	This option loads the YAML file for a FSP UPD into the ConfigEditor to change the desired configuration values.\r
	14	\r
	15	#####Example:\r
	16	```\r
	17	![Example ConfigEditor 1](https://slimbootloader.github.io/_images/CfgEditOpen.png)\r
	18	\r
	19	![Example ConfigEditor 2](https://slimbootloader.github.io/_images/CfgEditDefYaml.png)\r
	20	```\r
	21	\r
	22	## 2. Open Config BSF file\r
	23	This option loads the BSF file for a FSP UPD into the ConfigEditor to change the desired configuration values. It works as a similar fashion with Binary Configuration Tool (BCT)\r
	24	\r
	25	## 3. Show Binary Information\r
	26	This option loads configuration data from FD file and displays it in the ConfigEditor.\r
	27	\r
	28	## 4. Save Config Data to Binary\r
	29	This option generates a config binary blob for the newly changed values to take effect.\r
	30	\r
	31	## 5. Load Config Data from Binary\r
	32	This option reloads changed configuration from BIN file into the ConfigEditor.\r
	33	\r
	34	## 6. Load Config Changes from Delta File\r
	35	This option loads the changed configuration values from Delta file into the ConfigEditor.\r
	36	\r
	37	## 7. Save Config Changes to Delta File\r
	38	This option generates a new configuration delta file for the newly changed values to take effect.\r
	39	\r
	40	## 8. Save Full Config Data to Delta File\r
	41	This option saves all the changed configuration values into a Delta file.\r
	42	\r
cac83b6f LTL	43	## 9. Search feature\r
	44	This feature helps the user to easily find any configuration item they are looking for in ConfigEditor.\r
	45	A text search box is available on the Top Right Corner of ConfigEditor. To use this feature the user should type the name or a key word of the item they want to search in the text box and then click on the "Search" button. This will display all the items which contains that particular word searched by the user.\r
	46	\r
580b1120 LTL	47	## Running Configuration Editor:\r
	48	\r
	49	python ConfigEditor.py\r