diff options
author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-04-18 07:29:12 +0900 |
---|---|---|
committer | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-04-18 07:40:27 +0900 |
commit | 104401505ab30fa0317e6b878f9bf5bba1404096 (patch) | |
tree | 1e60bc462e39b3e5181e6a00053b0851aecd4a20 | |
parent | cc0083eeb2b807c63b0f311d1642f579e63407f2 (diff) | |
download | libhinoko-104401505ab30fa0317e6b878f9bf5bba1404096.tar.gz |
update README with information about backward compatibility
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r-- | README.rst | 26 |
1 files changed, 25 insertions, 1 deletions
@@ -2,7 +2,7 @@ libhinoko ========= -2022/04/17 +2022/04/18 Takashi Sakamoto Introduction @@ -74,6 +74,30 @@ How to refer document You can see documentation files under ``(directory-to-install)/share/doc/hinoko/``. +Loss of backward compatibility between v0.6/v0.7 releases +========================================================= + +The status of project is still under development. Below public functions are removed since v0.7 +release without backward compatibility: + +- ``Hinoko.FwIsoResource.allocate_once_async`` +- ``Hinoko.FwIsoResource.allocate_once_sync`` +- ``Hinoko.FwIsoResource.deallocate_once_async`` +- ``Hinoko.FwIsoResource.deallocate_once_sync`` + +``Hinoko.FwIsoResourceOnce`` is newly added and some alternative functions are available: + +- ``Hinoko.FwIsoResourceOnce.allocate_async`` +- ``Hinoko.FwIsoResourceOnce.allocate_sync`` +- ``Hinoko.FwIsoResourceOnce.deallocate_async`` +- ``Hinoko.FwIsoResourceOnce.deallocate_sync`` + +Additionally, below puclic functions are changed to have an argument for the value of timeout to +wait for event: + +- ``Hinoko.FwIsoResourceAuto.allocate_sync`` +- ``Hinoko.FwIsoResourceAuto.deallocate_sync`` + Loss of backward compatibility between v0.5/v0.6 releases ========================================================= |