fix existing markdownlint issues in file
Note that markdownlint tries to put <> around anything with a "@." in it
assuming it's an email. Need to add a \ before the @ to let it know it's
not a email address.
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
Change-Id: I97965e16512da80d60ae031f984c30faeb60014f
diff --git a/README.md b/README.md
index 6f2c7d2..c36c1e5 100644
--- a/README.md
+++ b/README.md
@@ -53,7 +53,7 @@
- CurrentBMCState: NotReady, Ready, Quiesced
- RequestedBMCTransition: Reboot
- Monitored systemd targets: multi-user.target and
- obmc-bmc-service-quiesce@.target
+ obmc-bmc-service-quiesce\@.target
- [chassis][3]: The chassis represents the physical hardware in which the system
is contained. It usually has the power supplies, fans, and other hardware
associated with it. It can be either `On`, `Off`, or in a fail state. A
@@ -61,8 +61,8 @@
and `UninterruptiblePowerSupply` indicates the chassis is running on a UPS.
- CurrentPowerState: On, Off, BrownOut, UninterruptiblePowerSupply
- RequestedPowerTransition: On, Off
- - Monitored systemd targets: obmc-chassis-poweron@.target,
- obmc-chassis-poweroff@.target
+ - Monitored systemd targets: obmc-chassis-poweron\@.target,
+ obmc-chassis-poweroff\@.target
- [host][4]: The host represents the software running on the system. In most
cases this is an operating system of some sort. The host can be `Off`,
`Running`, `TransitioningToRunning`, `TransitioningToOff`, `Quiesced`(error
@@ -71,9 +71,9 @@
Quiesced, DiagnosticMode
- RequestedHostTransition: Off, On, Reboot, GracefulWarmReboot,
ForceWarmReboot
- - Monitored systemd targets: obmc-host-startmin@.target,
- obmc-host-stop@.target, obmc-host-quiesce@.target,
- obmc-host-diagnostic-mode@.target
+ - Monitored systemd targets: obmc-host-startmin\@.target,
+ obmc-host-stop\@.target, obmc-host-quiesce\@.target,
+ obmc-host-diagnostic-mode\@.target
- [hypervisor][4]: The hypervisor is an optional package systems can install
which tracks the state of the hypervisor on the system. This state manager
object implements a limited subset of the host D-Bus interface.
@@ -120,17 +120,17 @@
- Create a file called /run/openbmc/chassis@0-on
- The presence of this file tells the services to alter their behavior because
the chassis is already powered on
-- Start the obmc-chassis-poweron@0.target
+- Start the obmc-chassis-poweron\@0.target
- The majority of services in this target will "fake start" due to the file
being present. They will report to systemd that they started and ran
successfully but they actually do nothing. This is what you would want in
this case. Power is already on so you don't want to run the services to turn
- power on. You do want to get the obmc-chassis-poweron@0.target in the Active
- state though so that the chassis object within PSM will correctly report
- that the chassis is `On`
+ power on. You do want to get the obmc-chassis-poweron\@0.target in the
+ Active state though so that the chassis object within PSM will correctly
+ report that the chassis is `On`
- Start a service to check if the host is on
-The chassis@0-on file is removed once the obmc-chassis-poweron@0.target becomes
+The chassis@0-on file is removed once the obmc-chassis-poweron\@0.target becomes
active (i.e. all service have been successfully started which are wanted or
required by this target).
@@ -138,13 +138,13 @@
response is received then similar logic to chassis is done:
- Create a file called /run/openbmc/host@0-on
-- Start the obmc-host-start@0.target
+- Start the obmc-host-start\@0.target
- Similar to above, most services will not run due to the file being created
and their service files implementing a
"ConditionPathExists=!/run/openbmc/host@0-request"
-The host@0-on file is removed once the obmc-host-start@0.target and
-obmc-host-startmin@0.target become active (i.e. all service have been
+The host@0-on file is removed once the obmc-host-start\@0.target and
+obmc-host-startmin\@0.target become active (i.e. all service have been
successfully started which are wanted or required by these targets).
## Building the Code