markdownlint: minor changes for new version
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I9bf316f2e1008af13e5cce4edcdd2db6fcdc9ef2
diff --git a/README.md b/README.md
index 3bf3704..c282b2a 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@
```
Optionally, building the tests and examples can be disabled by passing
-`-Dtests=disabled` and `-Dexamples=disabled` respectively to `meson.
+`-Dtests=disabled` and `-Dexamples=disabled` respectively to `meson`.
The sdbus++ application is installed as a standard Python package
using `setuptools`.
@@ -39,12 +39,11 @@
## C++ library
-The sdbusplus library builds on top of the
-[sd-bus](http://0pointer.net/blog/the-new-sd-bus-api-of-systemd.html)
-library to create a modern C++ API for D-Bus. The library attempts to be
-as lightweight as possible, usually compiling to exactly the sd-bus API
-calls that would have been necessary, while also providing compile-time
-type-safety and memory leak protection afforded by modern C++ practices.
+The sdbusplus library builds on top of the [sd-bus] library to create a modern
+C++ API for D-Bus. The library attempts to be as lightweight as possible,
+usually compiling to exactly the sd-bus API calls that would have been
+necessary, while also providing compile-time type-safety and memory leak
+protection afforded by modern C++ practices.
Consider the following code:
@@ -68,7 +67,7 @@
list of active users. The message and bus objects are automatically freed
when they leave scope and the message format strings are generated at compile
time based on the types being read. Compare this to the corresponding server
-code within [logind](https://github.com/systemd/systemd/blob/d60c527009133a1ed3d69c14b8c837c790e78d10/src/login/logind-dbus.c#L496).
+code within [logind].
In general, the library attempts to mimic the naming conventions of the sd-bus
library: ex. `sd_bus_call` becomes `sdbusplus::bus::call`,
@@ -77,6 +76,9 @@
etc. This allows a relatively straight-forward translation back to the sd-bus
functions for looking up the manpage details.
+[sd-bus]: http://0pointer.net/blog/the-new-sd-bus-api-of-systemd.html
+[logind]: https://github.com/systemd/systemd/blob/d60c527009133a1ed3d69c14b8c837c790e78d10/src/login/logind-dbus.c#L496
+
## Binding generation tool
sdbusplus also contains a bindings generator tool: `sdbus++`. The purpose of
diff --git a/docs/interface.md b/docs/interface.md
index 0579ee7..69ef12d 100644
--- a/docs/interface.md
+++ b/docs/interface.md
@@ -25,8 +25,9 @@
A common problem we have found with D-Bus interfaces is having a consistent
way to define enumerations. Two common practices are to either assign
special meaning to integers, as a C compiler might do, or to have specific
-strings representing the enumeration name. The [D-Bus API design guidelines](https://dbus.freedesktop.org/doc/dbus-api-design.html)
-specify both of these options:
+strings representing the enumeration name. The
+[D-Bus API design guidelines][dbus-design-guidelines] specify both of these
+options:
> For APIs being used in constrained situations, enumerated values should be
> transmitted as unsigned integers. For APIs which need to be extended by
@@ -70,8 +71,8 @@
### Base types
Types are identified in YAML using their typename found in the
-[D-Bus specification](https://dbus.freedesktop.org/doc/dbus-specification.html),
-but listed using lowercases: `int64` instead of `INT64` or C++ `int64_t`.
+[D-Bus specification][dbus-spec], but listed using lowercases: `int64`
+instead of `INT64` or C++ `int64_t`.
- `byte`
- `boolean`
@@ -233,3 +234,6 @@
- name: CardToTop
type: struct[enum[self.Suit], byte]
```
+
+[dbus-design-guidelines]: https://dbus.freedesktop.org/doc/dbus-api-design.html
+[dbus-spec]: https://dbus.freedesktop.org/doc/dbus-specification.html