diff options
author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2023-10-30 23:00:07 +0900 |
---|---|---|
committer | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2023-10-30 23:00:07 +0900 |
commit | 0f1b5500f4ef1d97f9629a3ba5b3fb0fa66f0a00 (patch) | |
tree | edd8871aa7709dd8cb2c55950d36503b5e2786c1 | |
parent | dfa3a18cfe5e067c2ef8b57cc846c773f30fb19c (diff) | |
download | libhinoko-0f1b5500f4ef1d97f9629a3ba5b3fb0fa66f0a00.tar.gz |
bump release version to 1.0.0v1.0.0
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r-- | README.rst | 128 | ||||
-rw-r--r-- | meson.build | 2 | ||||
-rwxr-xr-x | samples/iso-ir-multiple | 6 | ||||
-rwxr-xr-x | samples/iso-ir-single | 2 | ||||
-rwxr-xr-x | samples/iso-it | 2 | ||||
-rwxr-xr-x | samples/iso-resource | 3 | ||||
-rw-r--r-- | tests/fw-iso-ctx | 2 | ||||
-rwxr-xr-x | tests/fw-iso-ir-multiple | 2 | ||||
-rwxr-xr-x | tests/fw-iso-ir-single | 2 | ||||
-rwxr-xr-x | tests/fw-iso-it | 2 | ||||
-rw-r--r-- | tests/fw-iso-resource | 2 | ||||
-rw-r--r-- | tests/fw-iso-resource-auto | 2 | ||||
-rw-r--r-- | tests/fw-iso-resource-once | 2 | ||||
-rw-r--r-- | tests/hinoko-enum | 2 | ||||
-rw-r--r-- | tests/hinoko-functions | 2 |
15 files changed, 21 insertions, 140 deletions
@@ -2,7 +2,7 @@ The libhinoko project ===================== -2023/10/29 +2023/10/30 Takashi Sakamoto Introduction @@ -15,7 +15,7 @@ IEEE 1394 bus by any language binding of GObject Introspection. The applications operate 1394 OHCI hardware for any isochronous context and isochronous resources. According to this design, this library is an application of Linux FireWire subsystem and GLib/GObject. -The latest release is `0.9.0 <https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tag/?h=v0.9.0>`_ +The latest release is `1.0.0 <https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tag/?h=v1.0.0>`_ Example of Python 3 with PyGobject ================================== @@ -65,9 +65,9 @@ How to build $ meson install -C build ($ meson test -C build) -When working with gobject-introspection, ``Hinoko-0.0.typelib`` should be installed in your system +When working with gobject-introspection, ``Hinoko-1.0.typelib`` should be installed in your system girepository so that ``libgirepository`` can find it. Of course, your system LD should find ELF -shared object for libhinoko0. Before installing, it's good to check path of the above and configure +shared object for libhinoko1. Before installing, it's good to check path of the above and configure ``--prefix`` meson option appropriately. The environment variables, ``GI_TYPELIB_PATH`` and ``LD_LIBRARY_PATH`` are available for ad-hoc settings of the above as well. @@ -102,7 +102,7 @@ This is a sample of wrap file to satisfy dependency on libhinoko by [wrap-git] directory = hinoko url = https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git - revision = v0.9.1 + revision = v1.0.0 depth = 1 [provide] @@ -116,129 +116,13 @@ available. $ cat meson.build hinoko_dependency = dependency('hinoko', - version: '>=0.9.1' + version: '>=1.0.0' ) In the case of subproject, the wrap file for ``hinawa`` should be installed as well, since ``hinoko`` depends on it. For ``hinawa.wrap``, please refer to README of [libhinawa](https://git.kernel.org/pub/scm/libs/ieee1394/libhinawa.git/). -Loss of backward compatibility between v0.8/v0.9 releases -========================================================= - -At v0.9, the library newly depends on -`libhinawa <https://git.kernel.org/pub/scm/libs/ieee1394/libhinawa.git/>`_ to use -`Hinawa.CycleTime <https://alsa-project.github.io/gobject-introspection-docs/hinawa/struct.CycleTime.html>`_ -for -`Hinoko.FwIsoCtx.read_cycle_time() <https://alsa-project.github.io/gobject-introspection-docs/hinoko/method.FwIsoCtx.read_cycle_time.html>`_ -abstract method. The previous implementation, ``Hinoko.CycleTimer`` and -``Hinoko.FwIsoCtx.get_cycle_timer()``, is unused anymore and dropped. - -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 -========================================================= - -At v0.6, internal inheritance was heavily used to share functions, signals and properties. At v0.7, -the inheritance is obsoleted by utilizing GObject Interface, therefore below base classes becomes -simple interface. - -- ``Hinoko.FwIsoCtx`` -- ``Hinoko.FwResource`` - -The former is implemented by below classes inherits GObject directly: - -- ``Hinoko.FwIsoRxSingle`` -- ``Hinoko.FwIsoRxMultiple`` -- ``Hinoko.FwIsoTx`` - -The latter is implemented by below classes inherits GObject directly: - -- ``Hinoko.FwIsoResourceAuto`` -- ``Hinoko.FwIsoResourceOnce`` - -The ``Hinoko.FwIsoResourceOnce`` is newly added for allocation of isochronous resource bound -to current generation of bus topology, and some functions are available: - -- ``Hinoko.FwIsoResourceOnce.deallocate_async`` -- ``Hinoko.FwIsoResourceOnce.deallocate_sync`` - -These functions obsolete below functions. They are removed: - -- ``Hinoko.FwIsoResource.allocate_once_async`` -- ``Hinoko.FwIsoResource.allocate_once_sync`` -- ``Hinoko.FwIsoResource.deallocate_once_async`` -- ``Hinoko.FwIsoResource.deallocate_once_sync`` - -Below functions are removed as well: - -- ``Hinoko.FwIsoRxSingle.stop`` -- ``Hinoko.FwIsoRxSingle.unmap_buffer`` -- ``Hinoko.FwIsoRxSingle.release`` -- ``Hinoko.FwIsoRxMultiple.stop`` -- ``Hinoko.FwIsoRxMultiple.unmap_buffer`` -- ``Hinoko.FwIsoRxMultiple.release`` -- ``Hinoko.FwIsoTx.stop`` -- ``Hinoko.FwIsoTx.unmap_buffer`` -- ``Hinoko.FwIsoTx.release`` -- ``Hinoko.FwIsoResourceAuto.allocate_async`` -- ``Hinoko.FwIsoResourceAuto.allocate_sync`` - -Alternatively, below functions are available: - -- ``Hinoko.FwIsoCtx.stop`` -- ``Hinoko.FwIsoCtx.unmap_buffer`` -- ``Hinoko.FwIsoCtx.release`` -- ``Hinoko.FwIsoResource.allocate_async`` -- ``Hinoko.FwIsoResource.allocate_sync`` - -Furthermore, below puclic functions are changed to have an argument for the value of timeout to -wait for event: - -- ``Hinoko.FwIsoResourceAuto.deallocate_sync`` - -Beside, below signal is newly added to express the value of current generation for the state of -IEEE 1394 bus: - -- ``Hinoko.FwIsoResource::generation`` - -In GNOME convention, the throw function to report error at GError argument should return gboolean -value to report the overall operation finishes successfully or not. At v0.7, the most of public -API are rewritten according to it. - -Loss of backward compatibility between v0.5/v0.6 releases -========================================================= - -The status of project is under development. Below public functions have been changed since v0.6 -release without backward compatibility: - -- ``Hinoko.FwIsoTx.start()`` -- ``Hinoko.FwIsoTx.register_packet()`` -- ``Hinoko.FwIsoRxSingle.start()`` - -Furthermore hardware interrupt is not scheduled automatically in ``Hinoko.FwIsoTx`` and -``Hinoko.FwIsoRxSingle`` anymore. The runtime of v0.5 or before should be rewritten to schedule the -interrupt explicitly by calling ``Hinoko.FwIsoTx.register_packet()`` and -``Hinoko.FwIsoRxSingle.register_packet()`` if required. ``Hinawa.FwIsoCtx.flush_completions()`` -allows applciation to process content of packet without scheduling hardware interrupt. - About Hinoko ============ diff --git a/meson.build b/meson.build index c6579b6..8c55a6b 100644 --- a/meson.build +++ b/meson.build @@ -1,5 +1,5 @@ project('hinoko', 'c', - version: '0.9.1', + version: '1.0.0', license: 'LGPL-2.1+', meson_version: '>= 0.58.0', ) diff --git a/samples/iso-ir-multiple b/samples/iso-ir-multiple index d37fcb7..e1df7b6 100755 --- a/samples/iso-ir-multiple +++ b/samples/iso-ir-multiple @@ -4,10 +4,8 @@ from threading import Timer from struct import unpack import gi -gi.require_version('GLib', '2.0') -from gi.repository import GLib -gi.require_version('Hinoko', '0.0') -from gi.repository import Hinoko +gi.require_versions({'GLib': '2.0', 'Hinoko': '1.0'}) +from gi.repository import GLib, Hinoko class IsoIrMultiple(Hinoko.FwIsoIrMultiple): def new(self, path, bytes_per_packet, syt_interval): diff --git a/samples/iso-ir-single b/samples/iso-ir-single index 58d9bde..03ee4e2 100755 --- a/samples/iso-ir-single +++ b/samples/iso-ir-single @@ -4,7 +4,7 @@ from threading import Timer from struct import unpack import gi -gi.require_versions({'GLib': '2.0', 'Hinawa': '4.0', 'Hinoko': '0.0'}) +gi.require_versions({'GLib': '2.0', 'Hinawa': '4.0', 'Hinoko': '1.0'}) from gi.repository import GLib, Hinawa, Hinoko class IsoIrSingle(Hinoko.FwIsoIrSingle): diff --git a/samples/iso-it b/samples/iso-it index 14155c3..bd64171 100755 --- a/samples/iso-it +++ b/samples/iso-it @@ -4,7 +4,7 @@ from threading import Timer from struct import unpack,pack import gi -gi.require_versions({'GLib': '2.0', 'Hinawa': '4.0', 'Hinoko': '0.0'}) +gi.require_versions({'GLib': '2.0', 'Hinawa': '4.0', 'Hinoko': '1.0'}) from gi.repository import GLib, Hinawa, Hinoko class IsoIt(Hinoko.FwIsoIt): diff --git a/samples/iso-resource b/samples/iso-resource index bd9b72b..8ce7f73 100755 --- a/samples/iso-resource +++ b/samples/iso-resource @@ -1,8 +1,7 @@ #!/usr/bin/env python3 import gi -gi.require_version('GLib', '2.0') -gi.require_version('Hinoko', '0.0') +gi.require_versions({'GLib': '2.0', 'Hinoko': '1.0'}) from gi.repository import GLib, Hinoko from threading import Thread diff --git a/tests/fw-iso-ctx b/tests/fw-iso-ctx index 35bc31e..162c531 100644 --- a/tests/fw-iso-ctx +++ b/tests/fw-iso-ctx @@ -6,7 +6,7 @@ from errno import ENXIO from helper import test_object import gi -gi.require_version('Hinoko', '0.0') +gi.require_version('Hinoko', '1.0') from gi.repository import Hinoko target_type = Hinoko.FwIsoCtx diff --git a/tests/fw-iso-ir-multiple b/tests/fw-iso-ir-multiple index 07da395..4c87c9c 100755 --- a/tests/fw-iso-ir-multiple +++ b/tests/fw-iso-ir-multiple @@ -6,7 +6,7 @@ from errno import ENXIO from helper import test_object import gi -gi.require_version('Hinoko', '0.0') +gi.require_version('Hinoko', '1.0') from gi.repository import Hinoko target_type = Hinoko.FwIsoIrMultiple diff --git a/tests/fw-iso-ir-single b/tests/fw-iso-ir-single index 7816e35..05ce837 100755 --- a/tests/fw-iso-ir-single +++ b/tests/fw-iso-ir-single @@ -6,7 +6,7 @@ from errno import ENXIO from helper import test_object import gi -gi.require_version('Hinoko', '0.0') +gi.require_version('Hinoko', '1.0') from gi.repository import Hinoko target_type = Hinoko.FwIsoIrSingle diff --git a/tests/fw-iso-it b/tests/fw-iso-it index 8aae653..3e0a764 100755 --- a/tests/fw-iso-it +++ b/tests/fw-iso-it @@ -6,7 +6,7 @@ from errno import ENXIO from helper import test_object import gi -gi.require_version('Hinoko', '0.0') +gi.require_version('Hinoko', '1.0') from gi.repository import Hinoko target_type = Hinoko.FwIsoIt diff --git a/tests/fw-iso-resource b/tests/fw-iso-resource index 52ebf68..f17555f 100644 --- a/tests/fw-iso-resource +++ b/tests/fw-iso-resource @@ -6,7 +6,7 @@ from errno import ENXIO from helper import test_object import gi -gi.require_version('Hinoko', '0.0') +gi.require_version('Hinoko', '1.0') from gi.repository import Hinoko target_type = Hinoko.FwIsoResource diff --git a/tests/fw-iso-resource-auto b/tests/fw-iso-resource-auto index cbc908a..c7e5617 100644 --- a/tests/fw-iso-resource-auto +++ b/tests/fw-iso-resource-auto @@ -6,7 +6,7 @@ from errno import ENXIO from helper import test_object import gi -gi.require_version('Hinoko', '0.0') +gi.require_version('Hinoko', '1.0') from gi.repository import Hinoko target_type = Hinoko.FwIsoResourceAuto diff --git a/tests/fw-iso-resource-once b/tests/fw-iso-resource-once index 2a2c0ee..f5e7615 100644 --- a/tests/fw-iso-resource-once +++ b/tests/fw-iso-resource-once @@ -6,7 +6,7 @@ from errno import ENXIO from helper import test_object import gi -gi.require_version('Hinoko', '0.0') +gi.require_version('Hinoko', '1.0') from gi.repository import Hinoko target_type = Hinoko.FwIsoResourceOnce diff --git a/tests/hinoko-enum b/tests/hinoko-enum index 1c7c3e9..12c78e9 100644 --- a/tests/hinoko-enum +++ b/tests/hinoko-enum @@ -6,7 +6,7 @@ from errno import ENXIO from helper import test_enums import gi -gi.require_version('Hinoko', '0.0') +gi.require_version('Hinoko', '1.0') from gi.repository import Hinoko fw_iso_ctx_mode_enumerators = ( diff --git a/tests/hinoko-functions b/tests/hinoko-functions index 76750e2..2f8d883 100644 --- a/tests/hinoko-functions +++ b/tests/hinoko-functions @@ -4,7 +4,7 @@ from sys import exit from errno import ENXIO import gi -gi.require_version('Hinoko', '0.0') +gi.require_version('Hinoko', '1.0') from gi.repository import Hinoko from helper import test_functions |