docs: Minor formatting tweaks to EntityManagerDbusAPI
While looking over documentation, I noticed that the Entity Manager DBus
API was a bit hard to read due to some #### and other odd formatting
issues. Looks like, at least for GitHub flavored markdown, there needs
to be a space between # and the first character.
The cross-repository link for "upstream types" was also not rendering
correctly.
Change-Id: I1527f5f629bb575fa91b7bae5f96c8bec59e7db1
Signed-off-by: B. J. Wyman <bjwyman@gmail.com>
diff --git a/docs/EntityManagerDbusAPI.md b/docs/EntityManagerDbusAPI.md
index b4301a4..8b0660f 100644
--- a/docs/EntityManagerDbusAPI.md
+++ b/docs/EntityManagerDbusAPI.md
@@ -10,13 +10,13 @@
### Object Paths:
-####Entities: /xyz/openbmc_project/Inventory/Item/{Entity Type}/{Entity Name}
+#### Entities: /xyz/openbmc_project/Inventory/Item/{Entity Type}/{Entity Name}
Entities are top level json objects that describe a piece of hardware. They are
groups of configurations with few properties of their own, they are a container
type for most pratical purposes.
-####Devices : /xyz/openbmc_project/Inventory/Item/{Entity Type}/{Entity Name}/{Configuration}
+#### Devices : /xyz/openbmc_project/Inventory/Item/{Entity Type}/{Entity Name}/{Configuration}
Configurations are components that are exposed when an entity is added to the
"global" system configuration. An example would be a TMP75 sensor that is
@@ -28,12 +28,11 @@
/xyz/openbmc_project/Inventory/Item/Board/Intel_Front_Panel/Front_Panel_Temp
```
-###Interfaces :
+### Interfaces :
-####xyz.openbmc_project.{InventoryType}
+#### xyz.openbmc_project.{InventoryType}
-[see upstream types](https://github.com/openbmc/phosphor-dbus-interfaces/
-tree/master/xyz/openbmc_project/Inventory/Item)
+See [upstream types](https://github.com/openbmc/phosphor-dbus-interfaces/tree/master/xyz/openbmc_project/Inventory/Item)
* BMC
* Board
@@ -45,18 +44,18 @@
Entity objects describe pieces of physical hardware.
-#####Properties:
+##### Properties:
unsigned int: num_children: Number of configurations under this entity.
std::string name: name of the inventory item
-####xyz.openbmc_project.Configuration
+#### xyz.openbmc_project.Configuration
Configuration objects describe components owned by the Entity.
-#####Properties:
+##### Properties:
Properties will contain all non-objects (simple types) exposed by the JSON.
@@ -70,14 +69,14 @@
string "bus" = "1"
```
-####xyz.openbmc_project.Device.{Object}.{index}
+#### xyz.openbmc_project.Device.{Object}.{index}
{Object}s are members of the parent device that were originally described as
dictionaries. This allows for creating more complex types, while still being
able to get a picture of the entire system when doing a get managed objects
method call. Array objects will be indexed zero based.
-#####Properties:
+##### Properties:
All members of the dictonary.
@@ -90,9 +89,9 @@
int value = 55
```
-##JSON Requirements
+## JSON Requirements
-###JSON syntax requirements:
+### JSON syntax requirements:
Based on the above DBus object, there is an implicit requirement that device
objects may not have more than one level deep of dictionary or list of