regulators: Document config file name options
Document the options for naming the regulators JSON configuration file.
A config file can have the default file name, or it can have a file name
based on the values of the IBMCompatibleSystem D-Bus interface provided
by Entity Manager.
Rename the example config file to the default file name.
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: I8398d8c90e85731ab05c6aeaff3a5ea6e91114f8
diff --git a/phosphor-regulators/docs/config_file/README.md b/phosphor-regulators/docs/config_file/README.md
index f28884e..4ebebc2 100644
--- a/phosphor-regulators/docs/config_file/README.md
+++ b/phosphor-regulators/docs/config_file/README.md
@@ -1,5 +1,17 @@
# phosphor-regulators Configuration File
+## Table of Contents
+* [Overview](#overview)
+* [Data Format](#data-format)
+* [Example](#example)
+* [Name](#name)
+* [Contents](#contents)
+* [Validation](#validation)
+* [Installation](#installation)
+* [Loading and Reloading](#loading-and-reloading)
+* [Testing](#testing)
+
+
## Overview
The `phosphor-regulators` application is controlled by a configuration file
@@ -20,13 +32,54 @@
Notation)](https://www.json.org/) data format.
The config file can be created using any text editor, such as Atom, Notepad++,
-gedit, Vim, or Emacs. You can select any file name, but it must end with the
-".json" suffix, such as `regulators.json`.
+gedit, Vim, or Emacs.
## Example
-See [config_file.json](../../examples/config_file.json).
+See [config.json](../../examples/config.json).
+
+
+## Name
+
+There are two options for naming the config file:
+* [Default Name](#default-name)
+* [Name Based on System Type](#name-based-on-system-type)
+
+### Default Name
+
+The default config file name is `config.json`. The default name can be used if
+the BMC firmware image only supports one system type. It can also be used if
+the firmware image supports multiple system types that share a common config
+file.
+
+### Name Based on System Type
+
+The config file name can be based on the system type, such as
+`ibm_rainier.json`. This is required if the BMC firmware image supports
+multiple system types, and those system types do not share a common config
+file.
+
+The system type is obtained from the `IBMCompatibleSystem` D-Bus interface that
+is provided by the [Entity Manager](https://github.com/openbmc/entity-manager)
+application. The `Names` property of this interface contains a list of one or
+more compatible system types, ordered from most specific to most general.
+
+Example:
+* `ibm,rainier-2u`
+* `ibm,rainier`
+
+The `phosphor-regulators` application converts each system type into a
+corresponding config file name:
+* Replaces spaces and commas with underscores
+* Adds a ".json" suffix
+
+Example:
+* `ibm,rainier -> ibm_rainier.json`
+
+`phosphor-regulators` searches for a config file with one of these file names,
+from most specific to most general. If a config file is not found, it searches
+for a file with the [default name](#default-name).
## Contents
diff --git a/phosphor-regulators/examples/config_file.json b/phosphor-regulators/examples/config.json
similarity index 100%
rename from phosphor-regulators/examples/config_file.json
rename to phosphor-regulators/examples/config.json