Guidelines/API stability

From Apertis
Jump to: navigation, search

Contents

API and ABI stability

Summary

  • Define API stability guarantees for your project (#Stability)
  • Ensure version numbers are changed as appropriate when API changes (#Versioning)

API and ABI

At a high level, an API – Application Programming Interface – is the boundary between two components when developing against them. It is closely related to an ABI – Application Binary Interface – which is the boundary at runtime. It defines the possible ways in which other components can interact with a component. More concretely, this normally means the C headers of a library form its API, and compiled library symbols its ABI. The difference between an API and ABI is given by compilation of the code: there are certain things in a C header, such as #defines, which can cause a library's API to change without changing its ABI. But these differences are mostly academic, and for all practical purposes, API and ABI can be treated interchangeably.

Examples of API-incompatible changes to a C function would be to add a new parameter, change the function's return type, or remove a parameter.

However, many other parts of a project can form an API. If a daemon exposes itself on D-Bus, the interfaces exported there form an API. Similarly, if a C API is exposed in higher level languages by use of GIR, the GIR file forms another API — if it changes, any higher level code using it must also change.

Other examples of more unusual APIs are configuration file locations and formats, and GSettings schemas. Any changes to these could require code using your library to change.

Stability

API stability refers to some level of guarantee from a project that its API will only change in defined ways in the future, or will not change at all. Generally, an API is considered 'stable' if it commits to backwards-compatibility (defined below); but APIs could also commit to being unstable or even forwards-compatible. The purpose of API stability guarantees is to allow people to use your project from their own code without worrying about constantly updating their code to keep up with API changes. Typical API stability guarantees mean that code which is compiled against one version of a library will run without problems against all future versions of that library with the same minor version number — or similarly that code which runs against a daemon will continue to run against all future versions of that daemon with the same minor version number.

It is possible to apply different levels of API stability to components within a project. For example, the core functions in a library could be stable, and hence their API left unchanged in future; while the newer, less core functions could be left unstable and allowed to change wildly until the right design is found, at which point they could be marked as stable.

Several types of stability commonly considered:

  • Unstable: the API could change or be removed in future
  • Backwards-compatible: only changes which permit code compiled against the unmodified API to continue running against the modified API are allowed (for example, functions cannot be removed)
  • Forwards-compatible: only changes which permit code compiled against the modified API to run against the unmodified API are allowed (for example, functions cannot be added)
  • Totally stable: no changes are allowed to the API, only to the implementation

Typically, projects commit to backwards-compatibility when they say an API is 'stable'. Very few projects commit to total stability because it would prevent almost all further development of the project.

Versioning

API stability guarantees are strongly linked to project versioning; both package versioning and libtool versioning. Libtool versioning exists entirely for the purpose of tracking ABI stability, and is explained in detail on the Autotools Mythbuster or the Versioning page.

Package versioning (major.minor.micro) is strongly linked to API stability: typically, the major version number is incremented when backwards-incompatible changes are made (for example, when functions are renamed, parameters are changed, or functions are removed). The minor version number is incremented when forwards-incompatible changes are made (for example, when new public API is added). The micro version number is incremented when code changes are made without modifying API. See the Versioning page for more information.

API versioning is just as important for D-Bus APIs and GSettings schemas (if they are likely to change) as for C APIs. See the documentation on D-Bus API versioning for details.

For GIR APIs, their stability typically follows the C API stability, as they are generated from the C API. One complexity is that their stability additionally depends on the version of gobject-introspection used in generating the GIR, but recent versions have not changed much so this is not a major concern.

Checking for API users

If you are carrying out an API or ABI break, it can be useful to find everything that depends or build-depends on a particular library. One convenient way to do this is by using the grep-dctrl command.

For example, a developer considering an API or ABI break in the Ribchester volume-mounting service might use commands like this to determine which packages they need to inspect more closely:

$ grep-dctrl -s Filename -F Pre-Depends,Depends,Recommends ribchester /var/lib/apt/lists/*_Packages
Filename: pool/development/a/apertis-dev-tools/apertis-dev-tools_0.1703.4bu1_all.deb
Filename: pool/development/a/apertis-development-meta/apertis-development_0.1703.2bu2_amd64.deb
Filename: pool/sdk/a/apertis-sdk-meta/apertis-sdk_0.1706.1bu1_amd64.deb
Filename: pool/target/a/apertis-target-meta/apertis-target_0.1706.2bu1_amd64.deb
Filename: pool/target/c/canterbury/canterbury_0.1706.3-0co1bu1_amd64.deb
Filename: pool/target/f/frome/frome_0.1706.0-0co1bu1_amd64.deb
Filename: pool/target/f/frome/frome-tests_0.1706.0-0co1bu1_amd64.deb
Filename: pool/target/f/frome/frome-tools_0.1706.0-0co1bu1_amd64.deb
Filename: pool/target/r/ribchester/gir1.2-ribchester-0_0.1706.2-0co1bu1_amd64.deb
Filename: pool/target/r/ribchester/libribchester5-dbgsym_0.1706.2-0co1bu1_amd64.deb
Filename: pool/target/r/ribchester/ribchester_0.1706.2-0co1bu1_amd64.deb
Filename: pool/target/r/ribchester/ribchester-dbg_0.1706.1-0co2bu1_amd64.deb
Filename: pool/target/r/ribchester/ribchester-dbgsym_0.1706.2-0co1bu1_amd64.deb
Filename: pool/target/r/ribchester/ribchester-dev_0.1706.2-0co1bu1_amd64.deb
Filename: pool/target/r/ribchester/ribchester-doc_0.1706.2-0co1bu1_all.deb
Filename: pool/target/r/ribchester/ribchester-tests_0.1706.2-0co1bu1_amd64.deb
Filename: pool/target/r/ribchester/ribchester-tests-dbgsym_0.1706.2-0co1bu1_amd64.deb
Filename: pool/target/r/ribchester/ribchester-tools_0.1706.2-0co1bu1_amd64.deb

$ grep-dctrl -s Directory -F Build-Depends,Build-Depends-Arch,Build-Depends-Indep ribchester /var/lib/apt/lists/*_Sources
Directory: pool/target/f/frome

External links

Personal tools
Namespaces

Variants
Actions
Navigation
Tools