Updating help for vpd-tool
This commit updates the vpd-tool help section for ‘--file’ and for
‘-w’(write keyword) option to provide more information to the user.
Change-Id: I0c2f922a75219339775a6f18188ba8b13a783df5
Signed-off-by: Anupama B R <anupama.b.r1@ibm.com>
diff --git a/vpd-tool/src/vpd_tool_main.cpp b/vpd-tool/src/vpd_tool_main.cpp
index fa99c3b..18d71ef 100644
--- a/vpd-tool/src/vpd_tool_main.cpp
+++ b/vpd-tool/src/vpd_tool_main.cpp
@@ -277,8 +277,9 @@
auto l_keywordOption =
l_app.add_option("--keyword, -K", l_keywordName, "Keyword name");
- auto l_fileOption =
- l_app.add_option("--file", l_filePath, "Absolute file path");
+ auto l_fileOption = l_app.add_option(
+ "--file", l_filePath,
+ "Absolute file path,\nNote: For write operation, file should contain keyword’s value in either ascii or in hex format.");
auto l_keywordValueOption =
l_app.add_option("--value, -V", l_keywordValue,
@@ -297,7 +298,7 @@
l_app
.add_flag(
"--writeKeyword, -w,--updateKeyword, -u",
- "Write keyword, Note: Irrespective of DBus or hardware path provided, primary and backup, redundant EEPROM(if any) paths will get updated with given key value")
+ "Write keyword,\nNote: In case DBus path is provided, both EEPROM and DBus are updated with the given keyword's value.\nIn case EEPROM path is provided, only the given EEPROM is updated with the given keyword's value.")
->needs(l_objectOption)
->needs(l_recordOption)
->needs(l_keywordOption);