From 5baeaecad27464edd7174f9840402ce895bbd9cf Mon Sep 17 00:00:00 2001 From: Marius Vlad Date: Fri, 14 Jun 2019 13:10:12 +0300 Subject: [PATCH] README/CONTRIBUTING: Markdown fixes Found while being parsed by doxygen (when used recursively), this fixes the markdown bits as to be displayed properly. Signed-off-by: Marius Vlad --- CONTRIBUTING.md | 2 +- README.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21b3847a..370667c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,7 +37,7 @@ fork the core Weston repository, push your changes to a branch in your new repository, and then submit these patches for review through a merge request. Weston formerly accepted patches via `git-send-email`, sent to -**wayland-devel@lists.freedesktop.org**; these were +**wayland-devel\@lists.freedesktop.org**; these were [tracked using Patchwork](https://patchwork.freedesktop.org/projects/wayland/). Some old patches continue to be sent this way, and we may accept small new patches sent to the list, but please send all new patches through GitLab merge diff --git a/README.md b/README.md index bd701b9a..eabac0df 100644 --- a/README.md +++ b/README.md @@ -242,18 +242,22 @@ user visible API changes, thus should be not considered part of the API version. All new symbols should be guarded by the macro like the example given below: +~~~~ #if REQUIRE_LIBWESTON_API_VERSION >= 0x0101 bool weston_ham_sandwich(void); #endif +~~~~ In order to use the said symbol, the one will have a similar code in their configure.ac: +~~~~ PKG_CHECK_MODULES(LIBWESTON, [libweston-1 >= 1.1]) AC_DEFINE(REQUIRE_LIBWESTON_API_VERSION, [0x0101]) +~~~~ If the user is _not_ interested in forward compatibility, they can use 0xffff or similar high value. Yet doing so is not recommended.