Skip to content

Commit 9ba9006

Browse files
committed
doc UPDATE information about branches
1 parent 253700b commit 9ba9006

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ another basic building block for the [**Netopeer2** toolset](https://github.com/
3333
For a reference implementation of NETCONF client and server, check the
3434
**Netopeer2** project.
3535

36+
## Branches
37+
38+
The project uses 2 main branches `master` and `devel`. Other branches should not be cloned. In `master` there are files of the
39+
last official *release*. Any latest improvements and changes, which were tested at least briefly are found in `devel`. On every
40+
new *release*, `devel` is merged into `master`.
41+
42+
This means that when only stable official releases are to be used, either `master` can be used or specific *releases* downloaded.
43+
If all the latest bugfixes should be applied, `devel` branch is the one to be used. Note that whenever **a new issue is created**
44+
and it occurs on the `master` branch, the **first response will likely be** to use `devel` before any further provided support.
45+
3646
## libnetconf vs libnetconf2
3747

3848
**libnetconf2** is being developed with experiences gained from the development
@@ -45,7 +55,7 @@ of them is more suitable for your needs.
4555
To represent the schema and data trees, **libnetconf** uses libxml2, which is
4656
intended for different purposes - schema and data trees connected with YANG
4757
have specific needs and restrictions in comparison to more generic XML.
48-
Therefore, in **libnetconf2**, we have completely replaced libxml2 by
58+
Therefore, in **libnetconf2**, we have completely replaced libxml2 by
4959
[libyang](https://github.com/CESNET/libyang). It is much more efficient in work
5060
with YANG modeled data (which is the case of NETCONF messages) and this advantage
5161
then applies also to **libnetconf2**. The library connects data with the YANG

0 commit comments

Comments
 (0)