Merge pull request #584 from Rafostar/additional-docs

doc: Additional migration docs

doc/reference/clapper-gtk/clapper-gtk.toml.in

@@ -56,6 +56,7 @@ base_url = "https://github.com/Rafostar/clapper/tree/master/"
 [extra]
 # The same order will be used when generating the index
 content_files = [
+  "migrating-to-010.md",
 ]
 content_images = [
   "images/clapper-logo.svg",

doc/reference/clapper-gtk/meson.build

@@ -6,6 +6,10 @@ clappergtk_toml = configure_file(
   install_dir: join_paths(datadir, 'doc', 'clapper-gtk'),
 )
 
+extra_md_files = [
+  'migrating-to-010.md',
+]
+
 custom_target('clapper-gtk-doc',
   input: [
     clappergtk_toml,
@@ -24,6 +28,7 @@ custom_target('clapper-gtk-doc',
     '--content-dir=@0@'.format(meson.current_source_dir()),
     '@INPUT1@',
   ],
+  depend_files: extra_md_files,
   build_by_default: true,
   install: true,
   install_dir: join_paths(datadir, 'doc'),

doc/reference/clapper-gtk/migrating-to-010.md

@@ -0,0 +1,22 @@
+Title: Migrating to ClapperGtk 0.10
+Slug: migrating-to-010
+
+### AV widget
+
+Code of [class@ClapperGtk.Video] was split into a base class [class@ClapperGtk.Av] from which
+[class@ClapperGtk.Video] and newly added [class@ClapperGtk.Audio] widgets are made.
+
+This code split implies following changes:
+
+* Properties `auto-inhibit`, `inhibited` and `player` were moved into AV base class, since these
+are usually used without explicit need to specify object class they belong to, this change should
+not affect most use-cases.
+* Methods to get above properties are now in AV, but also left in video widget for compatibility purposes.
+* Built-in widget actions starting with `video.` prefix are deprecated (also left for compatibility).
+Implementations that used them are encouraged to use `av.` actions now. All actions from video widget were
+ported to AV widget as they were, so updating your app should be as easy as changing this action prefix.
+
+### Other Info
+
+Above describes changes to GTK integration library, for the playback library
+check out [other migration guide](../clapper/migrating-to-010.html).

doc/reference/clapper/migrating-to-010.md

@@ -10,8 +10,8 @@ Old [class@Clapper.Feature] objects (including `mpris`, `discoverer` and `server
 reasons, but all apps using them are advised to migrate to enhancer plugins which already surpassed former
 ones in what can be achieved with them.
 
-Since these are now in the form of plugins scanned during init, one of the differences is that you now check
+Since these are in the form of plugins scanned during init, one of the differences is that you now check
-their availablity at runtime instead of compile time like before.
+their availability at runtime instead of compile time like before.
 
 Something like this: