regulators: Discuss firmware update in README
Update the phosphor-regulators README.md file to discuss the impacts of
installing new firmware on the BMC.
Explain that installing new firmware does not affect the
/etc/phosphor-regulators directory. This means that a config file in
that directory will continue to override the standard config file after
a firmware update.
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Ic4419b5759d93cd796b693941874f696bffa6285
diff --git a/phosphor-regulators/docs/config_file/README.md b/phosphor-regulators/docs/config_file/README.md
index 6a62dc1..f28884e 100644
--- a/phosphor-regulators/docs/config_file/README.md
+++ b/phosphor-regulators/docs/config_file/README.md
@@ -148,6 +148,11 @@
directory. This avoids the need to build and install a new firmware image on
the BMC.
+The test directory might not exist on the BMC. If it is missing, create it
+using the following command:
+
+`mkdir /etc/phosphor-regulators`
+
### Search Order
The `phosphor-regulators` application will search the installation directories
@@ -155,6 +160,15 @@
1. test directory
2. standard directory
+### Firmware Updates
+
+When a new firmware image is installed on the BMC, it will update the config
+file in the standard directory.
+
+The test directory will **not** be modified by a firmware update. If a config
+file exists in the test directory, it will continue to override the config file
+in the standard directory.
+
## Loading and Reloading
@@ -163,11 +177,11 @@
To force the application to reload the config file, use the following command
on the BMC:
-``systemctl kill -s HUP phosphor-regulators.service``
+`systemctl kill -s HUP phosphor-regulators.service`
To confirm which config file was loaded, use the following command on the BMC:
-``journalctl -u phosphor-regulators.service | grep Loading``
+`journalctl -u phosphor-regulators.service | grep Loading`
## Testing
@@ -184,10 +198,14 @@
the file in the test directory.
* Boot the system. Regulator configuration changes (such as voltage settings)
are only applied during the boot.
+* View output from the `phosphor-regulators` application to make sure no errors
+ occurred. Use the command `journalctl -u phosphor-regulators.service`.
When finished testing, perform the following steps to revert to the standard
config file:
-* Remove the config file from the test directory.
+* Remove the config file from the test directory. If this is not done, the
+ test config file will continue to override the standard config file even
+ after a firmware update.
* Force the `phosphor-regulators` application to reload its config file,
causing it to find and load the file in the standard directory.
* Boot the system, if necessary, to apply the regulator configuration changes