@@ -43,12 +43,14 @@ On a Debian/Ubuntu system::
4343Compatibility
4444-------------
4545
46- The current version requires at least C `libyang 2.25 `__.
47-
48- The last version of the bindings that works with C `libyang 1.x `__ is v1.7.0 __.
49-
50- __ https://github.com/CESNET/libyang/commit/d2f1608b348f
51- __ https://github.com/CESNET/libyang/tree/libyang1
46+ - This version requires at least `libyang 3.1.0 `__ (`libyang.so 3.2.0 `__) and
47+ does not work with libyang v4 or later.
48+ - The last version of this package that works with libyang 2.x is `v2.8.4 `__.
49+ - The last version of this package that works with libyang 1.x is `v1.7.0 `__.
50+
51+ __ https://github.com/CESNET/libyang/releases/tag/v3.1.0
52+ __ https://github.com/CESNET/libyang/commit/5109b8149cfc
53+ __ https://pypi.org/project/libyang/2.8.4/
5254__ https://pypi.org/project/libyang/1.7.0/
5355
5456Compilation Flags
@@ -321,3 +323,22 @@ Here are the steps for submitting a change in the code base:
321323 your topic branch.
322324
323325Thank you in advance for your contributions!
326+
327+ Libyang v3 Compatibility Branch
328+ -------------------------------
329+
330+ Libyang v3 compatibility is being maintained for now using the `b_3.x `__ branch.
331+
332+ For contributors, v3 specific changes should be made with a PR against the
333+ `b_3.x `__ branch; however, if the change is valid for more recent libyang releases
334+ as well (e.g., v4) then the change should first be made with a PR against the
335+ `master `__ branch.
336+
337+ For maintainers, in order to create new v3 releases on pypi.org, a git push of a
338+ signed/annotated tag on that branch following the pattern v3.x.y where x and y
339+ are positive integers. Semantic versions should be used where it makes sense.
340+ The CI will take care of the rest.
341+
342+ __ https://github.com/CESNET/libyang-python/tree/b_3.x
343+ __ https://github.com/CESNET/libyang-python/tree/b_3.x
344+ __ https://github.com/CESNET/libyang-python
0 commit comments