Document WESTON_VERSION_AT_LEAST() macro behavior
authorKristian Høgsberg <krh@bitplanet.net>
Mon, 27 Jan 2014 20:07:19 +0000 (12:07 -0800)
committerKristian Høgsberg <krh@bitplanet.net>
Mon, 27 Jan 2014 20:07:19 +0000 (12:07 -0800)
commit5f1ea4eb6fbe91984b53a7402c73c99466cc4f3b
tree7ad0258313f7b55295cc23e2e419799b9a11d32f
parent181131253747500c4759a117ee312262fbb6ed19
Document WESTON_VERSION_AT_LEAST() macro behavior

Adding this comment to explain the behavior:

  This macro may not do what you expect.  Weston doesn't guarantee any
  stable API between 1.X and 1.Y, and thus this macro will return
  FALSE on any WESTON_VERSION_AT_LEAST(1,X,0) if the actualy version
  is 1.Y.0 and X !=Y).  In particular, it fail if X < Y, that is,
  1.3.0 is considered to not be "at least" 1.4.0.

  If you want to test for the version number being 1.3.0 or above or
  maybe in a range (eg 1.2.0 to 1.4.0), just use the WESTON_VERSION_*
  defines above directly.

Version number testing is the one thing we can't break in the weston API,
so we'll have to settle for documenting the behavior and recommending
using the version number macros directly.

https://bugs.freedesktop.org/show_bug.cgi?id=74023
src/version.h.in