diff options
| author | Simon McVittie <smcv@collabora.com> | 2018-10-03 16:30:04 +0100 |
|---|---|---|
| committer | Simon McVittie <smcv@collabora.com> | 2018-10-03 16:30:04 +0100 |
| commit | 99d9758d90a88b92fc8fcdb447aa7ab4abe1c1cb (patch) | |
| tree | 27c739247da1a9db2bab0f49d04b278b57430152 | |
| parent | 2d4ead6f2fb3d288cf3a3897765d69e6602140b0 (diff) | |
| download | dbus-glib-99d9758d90a88b92fc8fcdb447aa7ab4abe1c1cb.tar.gz | |
Use Markdown for documentation
Signed-off-by: Simon McVittie <smcv@collabora.com>
| -rw-r--r-- | CONTRIBUTING.md (renamed from CONTRIBUTING) | 0 | ||||
| -rw-r--r-- | Makefile.am | 4 | ||||
| -rw-r--r-- | README.md (renamed from README) | 18 |
3 files changed, 12 insertions, 10 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING.md index 5bbcee1..5bbcee1 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING.md diff --git a/Makefile.am b/Makefile.am index cc46f6e..3e60286 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,8 +1,8 @@ EXTRA_DIST = \ AUTHORS \ - CONTRIBUTING \ + CONTRIBUTING.md \ COPYING \ - README \ + README.md \ $(NULL) AM_CPPFLAGS = \ @@ -24,26 +24,28 @@ dbus-gmain requires GLib >= 2.40. This can be reduced to 2.32, or probably older, if you don't build the tests. If you use the included Makefile.am (which requires building the tests), -you must check for libdbus via pkg-config using the prefix "DBUS", check +you must check for libdbus via pkg-config using the prefix `DBUS`, check for GLib (and optionally gobject and gio) via pkg-config using the prefix -"GLIB", and check for DBUS_RUN_SESSION for the tests: +`GLIB`, and check for `DBUS_RUN_SESSION` for the tests: +``` PKG_CHECK_MODULES([DBUS], [dbus-1 >= 1.8]) PKG_CHECK_MODULES([GLIB], [glib-2.0 >= 2.40]) AC_ARG_VAR([DBUS_RUN_SESSION], [The dbus-run-session tool from dbus 1.8 or later]) AC_PATH_PROG([DBUS_RUN_SESSION], [dbus-run-session], [dbus-run-session]) +``` Alternatively, you can include dbus-gmain.[ch] among the source files for some executable or library. -By default, dbus-gmain declares its functions in the dbus_gmain_* -namespace. To change this, define DBUS_GMAIN_FUNCTION_NAME(name) to +By default, dbus-gmain declares its functions in the `dbus_gmain_`\* +namespace. To change this, define `DBUS_GMAIN_FUNCTION_NAME(name)` to a suitably prefixed or suffixed version of name. The default is -"dbus_gmain_ ## name". +`dbus_gmain_ ## name`. -By default, dbus-gmain declares its functions G_GNUC_INTERNAL, so they +By default, dbus-gmain declares its functions `G_GNUC_INTERNAL`, so they will not be part of your library's ABI on supported compilers. To change -this (not recommended), define DBUS_GMAIN_FUNCTION(ret, name, ...) to +this (not recommended), define `DBUS_GMAIN_FUNCTION(ret, name, ...)` to a form that includes suitable decorators. The default is -"G_GNUC_INTERNAL ret DBUS_GMAIN_FUNCTION_NAME (name) (__VA_ARGS__)". +`G_GNUC_INTERNAL ret DBUS_GMAIN_FUNCTION_NAME (name) (__VA_ARGS__)`. |