diff --git a/libfwupdplugin/README.md b/libfwupdplugin/README.md index b848cd42c..893f94685 100644 --- a/libfwupdplugin/README.md +++ b/libfwupdplugin/README.md @@ -6,25 +6,39 @@ removed when branching for new minor versions. Remember: Plugins should be upstream! -## Migrating from older API +## 1.5.5 -* Migrate from fu_common_is_cpu_intel() to fu_common_get_cpu_vendor() -* Migrate from fu_firmware_strparse_uintXX() to fu_firmware_strparse_uintXX_safe() -* Remove calls to fu_plugin_get_usb_context() and fu_plugin_set_usb_context() -* Migrate from fu_plugin_runner_usb_device_added(), fu_plugin_runner_udev_device_added() and fu_plugin_runner_udev_device_changed() to fu_plugin_runner_backend_device_added() -* Migrate from FuHidDevice->open() and FuHidDevice->close() to using the superclass helpers -* Migrate from FuUsbDevice->probe(), FuUsbDevice->open() and FuUsbDevice->close() to using the superclass helpers -* Migrate from FuUdevDevice->to_string(), FuUdevDevice->probe(), FuUdevDevice->open() and FuUdevDevice->close() to using the superclass helpers -* Migrate from fu_device_get_protocol() to fu_device_get_protocols() and fu_device_set_protocol() to fu_device_add_protocol() -* Migrate from fu_device_has_custom_flag() to fu_device_has_private_flag() -* Migrate from fu_udev_device_set_readonly() to fu_udev_device_set_flags() -* Migrate from fu_device_sleep_with_progress() to fu_progress_sleep() -- but be aware the unit of time has changed from *seconds* to *milliseconds* -* Migrate from fu_device_get_status() to fu_progress_get_status() -* Migrate from fu_device_set_status() to fu_progress_set_status() -* Migrate from fu_device_get_progress() to fu_progress_get_percentage() -* Migrate from fu_device_set_progress_full() to fu_progress_set_percentage_full() -* Migrate from fu_device_set_progress() to fu_progress_set_steps(), fu_progress_add_step() and fu_progress_done -- see the FuProgress docs for more details! +* `fu_common_is_cpu_intel()`: Use `fu_common_get_cpu_vendor()` instead. +* `fu_firmware_strparse_uintXX()`: Use `fu_firmware_strparse_uintXX_safe()` instead. +* `fu_plugin_get_usb_context()`: Remove, as no longer required. +* `fu_plugin_set_usb_context()`: Remove, as no longer required. +* `fu_plugin_runner_usb_device_added()`: Use `fu_plugin_runner_backend_device_added()` instead. +* `fu_plugin_runner_udev_device_added()`: Use `fu_plugin_runner_backend_device_added()` instead. +* `fu_plugin_runner_udev_device_changed()`: Use `fu_plugin_runner_backend_device_added()` instead. +* `FuHidDevice->open()`: Use the `FuDevice` superclass instead. +* `FuHidDevice->close()`: Use the `FuDevice` superclass instead. +* `FuUsbDevice->probe()`: Use the `FuDevice` superclass instead. +* `FuUsbDevice->open()`: Use the `FuDevice` superclass instead. +* `FuUsbDevice->close()`: Use the `FuDevice` superclass instead. +* `FuUdevDevice->to_string()`: Use the `FuDevice` superclass instead. +* `FuUdevDevice->probe()`: Use the `FuDevice` superclass instead. +* `FuUdevDevice->open()`: Use the `FuDevice` superclass instead. +* `FuUdevDevice->close()`: Use the `FuDevice` superclass instead. -## Planned API/ABI changes for next release +## 1.5.6 -* Nothing yet. +* `fu_device_get_protocol()`: Use `fu_device_get_protocols()` instead. +* `fu_device_set_protocol()`: Use `fu_device_add_protocol()` instead. + +## 1.6.2 + +* `fu_device_has_custom_flag()`: Use `fu_device_has_private_flag()` instead. + +## 1.6.3 + +* `fu_device_sleep_with_progress()`: Use `fu_progress_sleep()` instead -- but be aware the unit of time has changed from *seconds* to *milliseconds*. +* `fu_device_get_status()`: Use `fu_progress_get_status()` instead. +* `fu_device_set_status()`: Use `fu_progress_set_status()` instead. +* `fu_device_get_progress()`: Use `fu_progress_get_percentage()` instead. +* `fu_device_set_progress_full()`: Use `fu_progress_set_percentage_full()` instead. +* `fu_device_set_progress()`: Use `fu_progress_set_steps()`, `fu_progress_add_step()` and `fu_progress_done()` -- see the `FuProgress` docs for more details!