diff options
| author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-12-18 10:44:46 +0900 |
|---|---|---|
| committer | 坂本 貴史 <o-takashi@sakamocchi.jp> | 2022-12-18 15:38:44 +0900 |
| commit | 5a9b19cf1293ee2fe4d2afbf4bd8e7e42c3ef405 (patch) | |
| tree | 3118b604849ad6046f5e87d438d48891583f72c7 | |
| parent | 0504fd7ff5852d0cb4ad784325f00616b666444a (diff) | |
| download | libhinoko-5a9b19cf1293ee2fe4d2afbf4bd8e7e42c3ef405.tar.gz | |
update README to describe loss of backward compatibility at v0.8 release
Rename of object class brings loss of backward compatibility. This commit
adds description about it.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
| -rw-r--r-- | README.rst | 21 |
1 files changed, 20 insertions, 1 deletions
@@ -2,7 +2,7 @@ The libhinoko project ===================== -2022/12/01 +2022/12/18 Takashi Sakamoto Introduction @@ -83,6 +83,25 @@ Supplemental information for language bindings with g-i. * `hinoko-rs <https://github.com/takaswie/hinoko-rs>`_ includes creates to use these libraries. +Loss of backward compatibility between v0.7/v0.8 releases +========================================================= + +At v0.8, some main object classes are renamed so that their names are straightforward to express +corresponding isochronous contexts in 1394 OHCI. + +- ``Hinoko.FwIsoIrSingle`` from ``Hinoko.FwIsoRxSingle`` for IR context of packet-per-buffer mode +- ``Hinoko.FwIsoIrMultiple`` from ``Hinoko.FwIsoRxMultiple`` for IR context of buffer-fill mode +- ``Hinoko.FwIsoIt`` from ``Hinoko.FwIsoTx`` for IT context + +The enumrations to express the mode of context are renamed as well: + +- ``Hinoko.FwIsoCtxMode.IR_SINGLE`` from ``Hinoko.FwIsoCtxMode.RX_SINGLE`` +- ``Hinoko.FwIsoCtxMode.IR_MULTIPLE`` from ``Hinoko.FwIsoCtxMode.RX_MULTIPLE`` +- ``Hinoko.FwIsoCtxMode.IT`` from ``Hinoko.FwIsoCtxMode.TX`` + + +The symbols for previous names are not public anymore. + Loss of backward compatibility between v0.6/v0.7 releases ========================================================= |