[PATCH docs 1/2] Clean up formatting

Milton Miller II miltonm at us.ibm.com
Tue Jul 12 07:40:56 AEST 2016

Replying to my own patch with some minor changelog deficiencies

>When reviewing the formatted output I discovered my receint additions


>to the dbus interfaces did not have trailing periods.  In addition
>one of the entries did not parse the bold formatting.  I tracked
>the later down to a space between the text and the intended end bold.
>I also added a few columns to headers where the text was longer than
>the initial columns.  This makes the file a bit easier to read when
>viewing the markdown as plain text.
>Signed-off-by: Milton Miller <miltonm at us.ibm.com>
> dbus-interfaces.md | 22 +++++++++++-----------
> 1 file changed, 11 insertions(+), 11 deletions(-)

>-| `Apply`             | `void`       | `void`        | **Initiate
>writing image into flash**|

I also changed the preposition, now 'write to' vs 'write into' ....

>-| `GetUpdateProgress` | `void`       | `s`           | **Display
>progress log `Apply` phase**|
>-|                     |              | `s`           | The `state`
>and log output from `Apply` |
>+| `PrepareForUpdate`  | `void`       | `void`        | **Reboot BMC
>with Flash content cached in RAM.**|
>+| `Abort`             | `void`       | `void`        | **Abort any
>pending, broken, or in-progress flash update.**|
>+| `Apply`             | `void`       | `void`        | **Initiate
>writing image to flash.**|
>+| `GetUpdateProgress` | `void`       | `s`           | **Display
>progress log `Apply` phase.**|
>+|                     |              | `s`           | The `status`
>and log output from `Apply`|

... and corrected the property name from 'state' to 'status'.

Let me know if I need to resend.


More information about the openbmc mailing list