summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2021-11-17 22:33:45 +0000
committerEmmanuele Bassi <ebassi@gnome.org>2021-11-17 22:33:45 +0000
commitbb07ce744638bc562c28d39a47ff8ce9b97211ab (patch)
tree57f5900e54cf06e4bd1c2e4e09eeb098eb982123
parent19c944471e410dccdee3b1d2d1ae52a0bc3819be (diff)
downloadlibgweather-bb07ce744638bc562c28d39a47ff8ce9b97211ab.tar.gz
docs: Divide migration guide in two
We have one section that lists changes that can be performed while still using GWeather 3.x, and another section that outlines changes that can only be done when porting to GWeather 4.
-rw-r--r--doc/migrating-3to4.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/migrating-3to4.md b/doc/migrating-3to4.md
index b525551..7fe97c8 100644
--- a/doc/migrating-3to4.md
+++ b/doc/migrating-3to4.md
@@ -1,6 +1,6 @@
Title: Migrating from GWeather 3.x to GWeather 4
-## Migrating from GWeather 3.x to GWeather 4
+# Migrating from GWeather 3.x to GWeather 4
GWeather 4 is a new major version that breaks API and ABI compared with
GWeather 3.
@@ -12,6 +12,11 @@ zone. Applications should provide their own UI, if needed, according to the
best practices of the [GNOME human interface
guidelines](https://developer.gnome.org/hig/).
+## Preparations
+
+Before migrating to GWeather 4, there are steps to follow in order to minimise
+the changes you have to implement once you switch.
+
### Stop using `gweather_location_get_children()`
In order to iterate over the child locations of a [class@GWeather.Location],
@@ -46,6 +51,11 @@ method has been returning `NULL` since then.
The Yahoo! provider was removed in libgweather 3.28.
+## Changes
+
+The following changes in GWeather 4 are incompatible with GWeather 3.x, and
+must be performed at the time of the port.
+
### `GWeatherLocation` is a GObject
[class@GWeather.Location] has been promoted to a full `GObject` type. This