Skip to content
Snippets Groups Projects
Commit 5f1123a1 authored by Walter Lozano's avatar Walter Lozano
Browse files

Improve supported API doc


Improve supported API doc formatting by removing inline links and
correcting minor space issues.

Signed-off-by: default avatarWalter Lozano <walter.lozano@collabora.com>
parent f25b84d0
No related branches found
No related tags found
1 merge request!365Improve supported API doc
......@@ -74,7 +74,7 @@ JavaScript. In this situation, API stability requires both the C
declarations to be stable, plus the conversion of those declarations to
a GIR file to be stable — so it is affected by changes in the
implementation of the GIR scanner (the g-ir-scanner utility provided by
gobject-introspection). This is covered further in [ABI is not just library symbols]( {{< ref "#abi-is-not-just-library-symbols" >}} ).
gobject-introspection). This is covered further in [ABI is not just library symbols].
# API and ABI stability strategies
......@@ -462,7 +462,7 @@ possible. Most existing open source APIs related to core functionality
fall in this support level: Mx, clutter, clutter-gst, GStreamer, and so
on.
As discussed in section 3.5.1, [The GTK upgrade and a Clutter API break]( {{< ref "#the-gtk-upgrade-and-a-clutter-api-break" >}} ),
As discussed in section 3.5.1, [The GTK upgrade and a Clutter API break],
there are ways to deal with ABI/API breakage in these libraries. Keeping
both versions installed for a while is one of them. In the short term
there will be at least one set of API changes that will have a big
......@@ -479,7 +479,7 @@ be ported, of course. Components that are based on Clutter such as
clutter-gst will need to be updated too. Illustration Illustration shows
how an application process could end up in this situation.
This would lead to the kind of problems discussed in [When a core library breaks]( {{< ref "#when-a-core-library-breaks" >}} )
This would lead to the kind of problems discussed in [When a core library breaks]
for applications that use clutter both directly
and indirectly through another library that uses clutter under the hood,
for instance. An application that uses both SDK UI APIs and an earlier
......@@ -666,8 +666,10 @@ including shipping more versions of the same library in parallel.
Limiting the API that is considered supported and requiring that some
libraries be statically linked or be shipped along with the program are
also tools that should be used where
necessary.
necessary.
[ABI is not just library symbols]: {{< ref "#abi-is-not-just-library-symbols" >}}
[Android-api-removals]: http://developer.android.com/sdk/api_diff/14/changes/alldiffs_index_removals.html
[iOS-api-changes]: https://developer.apple.com/library/ios/#releasenotes/General/iOS50APIDiff/index.html
[The GTK upgrade and a Clutter API break]: {{< ref "#the-gtk-upgrade-and-a-clutter-api-break" >}}
[When a core library breaks]: {{< ref "#when-a-core-library-breaks" >}}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment