[PATCH weston 2/4] README: minor the libweston ABI/API documentation

[Pekka Paalanen]

On Fri,  3 Jun 2016 14:27:37 +0100
Emil Velikov <emil.l.velikov at gmail.com> wrote:

> From: Emil Velikov <emil.velikov at collabora.com>
> 
> Signed-off-by: Emil Velikov <emil.velikov at collabora.com>
> ---
>  README | 22 +++++++++++-----------
>  1 file changed, 11 insertions(+), 11 deletions(-)
> 
> diff --git a/README b/README
> index 76be7b9..b8aa2e0 100644
> --- a/README
> +++ b/README
> @@ -41,25 +41,25 @@ continue evolving through many Weston releases before it achieves a
>  stable API and feature completeness.
>  
>  
> -API (in)stability and parallel installability
> ----------------------------------------------
> +API/ABI (in)stability and parallel installability
> +-------------------------------------------------
>  
>  As libweston's API surface is huge, it is impossible to get it right
> -in one go. Therefore developers reserve the right to break the API
> +in one go. Therefore developers reserve the right to break the API/ABI
>  between every 1.x.0 Weston release (minor version bumps), just like
>  Weston's plugin API does. For git snapshots of the master branch, the
> -API can break any time without warning or version bump.
> +API/ABI can break any time without warning or version bump.
>  
>  Libweston API or ABI will not be broken between Weston's stable
>  releases 1.x.0 and 1.x.y, where y < 90.
>  
> -To make things tolerable for libweston users despite ABI breakages,
> +To make things tolerable for libweston users despite API/ABI breakages,
>  libweston is designed to be perfectly parallel-installable. An
> -ABI-version is defined for libweston, and it is bumped for releases as
> -needed. Different ABI-versions of libweston can be installed in
> -parallel, so that external projects can easily depend on a particular
> -ABI-version, and they do not have to fight over which ABI-version is
> -installed in a user's system. This allows a user to install many
> +API/ABI-version is defined for libweston, and it is bumped for releases as
> +needed. Different non-backward compatible ABI versions of libweston can be
> +installed in parallel, so that external projects can easily depend on a
> +particular ABI-version. Thus they do not have to fight over which ABI-version
> +is installed in a user's system. This allows a user to install many
>  different compositors each requiring a different libweston ABI-version
>  without tricks or conflicts.
>  
> @@ -157,7 +157,7 @@ would be roughly like this:
>  - and possibly more...
>  
>  Everything should be parallel-installable across libweston
> -ABI-versions, except those explicitly mentioned.
> +major ABI-versions, except those explicitly mentioned.
>  
>  Weston's build may not sanely allow this yet, but this is the
>  intention.

Hi,

Reviewed-by: Pekka Paalanen <pekka.paalanen at collabora.co.uk>

but I wonder what "major ABI-version" refer to here, exactly. Since
"ABI version" was rejected(?), we do not have a good name for that
number.


Thanks,
pq
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 811 bytes
Desc: OpenPGP digital signature
URL: <https://lists.freedesktop.org/archives/wayland-devel/attachments/20160606/3f08660b/attachment-0001.sig>