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 <marius.vlad@collabora.com>
dev
Marius Vlad 6 years ago committed by Pekka Paalanen
parent 48392643ec
commit 5baeaecad2
  1. 2
      CONTRIBUTING.md
  2. 4
      README.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. repository, and then submit these patches for review through a merge request.
Weston formerly accepted patches via `git-send-email`, sent to 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/). [tracked using Patchwork](https://patchwork.freedesktop.org/projects/wayland/).
Some old patches continue to be sent this way, and we may accept small new 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 patches sent to the list, but please send all new patches through GitLab merge

@ -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: All new symbols should be guarded by the macro like the example given below:
~~~~
#if REQUIRE_LIBWESTON_API_VERSION >= 0x0101 #if REQUIRE_LIBWESTON_API_VERSION >= 0x0101
bool bool
weston_ham_sandwich(void); weston_ham_sandwich(void);
#endif #endif
~~~~
In order to use the said symbol, the one will have a similar code in their In order to use the said symbol, the one will have a similar code in their
configure.ac: configure.ac:
~~~~
PKG_CHECK_MODULES(LIBWESTON, [libweston-1 >= 1.1]) PKG_CHECK_MODULES(LIBWESTON, [libweston-1 >= 1.1])
AC_DEFINE(REQUIRE_LIBWESTON_API_VERSION, [0x0101]) AC_DEFINE(REQUIRE_LIBWESTON_API_VERSION, [0x0101])
~~~~
If the user is _not_ interested in forward compatibility, they can use 0xffff If the user is _not_ interested in forward compatibility, they can use 0xffff
or similar high value. Yet doing so is not recommended. or similar high value. Yet doing so is not recommended.

Loading…
Cancel
Save