summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPekka Paalanen <pekka.paalanen@collabora.com>2019-02-06 16:42:09 +0200
committerPekka Paalanen <pekka.paalanen@collabora.com>2019-02-06 16:50:21 +0200
commit1ed3506b70d988493b91861c5761e8a7ed88e772 (patch)
treeea9898f568e4d97dd3e9ccc9cef593783ee2c546 /README.md
parent7261edfe363482e140162cc18534a8e46f01915c (diff)
downloadweston-1ed3506b70d988493b91861c5761e8a7ed88e772.tar.gz
libweston: export weston_config API
Make it official that libweston will export the weston_config API, as requested in https://gitlab.freedesktop.org/wayland/weston/merge_requests/29 . There is no other way third party helper clients could access the API. The autotools build has been accidentally exporting it all the time, but the Meson build needed fixing. Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index d61b9322..d62da517 100644
--- a/README.md
+++ b/README.md
@@ -88,6 +88,13 @@ Libweston was first introduced in Weston 1.12, and is expected to
continue evolving through many Weston releases before it achieves a
stable API and feature completeness.
+Libweston's primary purpose is exporting an API for creating Wayland
+compositors. Libweston's secondary purpose is to export the weston_config API
+so that third party plugins and helper programs can read `weston.ini` if they
+want to. However, these two scopes are orthogonal and independent. At no point
+will the compositor functionality use or depend on the weston_config
+functionality.
+
API/ABI (in)stability and parallel installability
-------------------------------------------------