Gitiles
Code Review Sign In
gerrit.cesnet.cz / github / CESNET / libyang / cd7958cd963664bdce0881e74b1a4384b5990b69
commitcd7958cd963664bdce0881e74b1a4384b5990b69[log] [tgz]
authorMichal Vasko <mvasko@cesnet.cz>Wed Oct 14 11:51:49 2015 +0200
committerMichal Vasko <mvasko@cesnet.cz>Wed Oct 14 11:51:49 2015 +0200
treec1d2968884371af269dcc81b60e2ffb76207bdb3
parent06b0c74ebf42994f77295836d076ded210581922 [diff]
xml OPTIMIZE recursion removed, root should only be found once
1 file changed
tree: c1d2968884371af269dcc81b60e2ffb76207bdb3
  1. .gitignore
  2. .travis.yml
  3. CMakeLists.txt
  4. CMakeModules/
  5. CODINGSTYLE
  6. Doxyfile.in
  7. README.md
  8. doc/
  9. linenoise/
  10. models/
  11. src/
  12. tests/
  13. tools/
README.md

libyang

Travis CI: Build Status

Coverity Scan: Coverity Scan Build Status

libyang is YANG data modelling language parser and toolkit written (and providing API) in C.

Planned Features

  • parsing (and validating) data models in YANG format
  • parsing (and validating) data models in YIN format
  • reading instance data in XML format and validating
  • reading instance data in JSON format and validating
  • storing instance data in XML format
  • storing instance data in JSON format

Requirements

  • cmake >= 2.6
  • libpcre
  • cmocka >= 1.0.0 (for tests only, see Tests)

Building

$ mkdir build; cd build
$ cmake ..
$ make 
# make install

Build Modes

There are two build modes:

  • Release. This generates library for the production use without any debug information.
  • Debug. This generates library with the debug information and disables optimization of the code.

The Debug mode is currently used as the default one. to switch to the Release mode, enter at the command line:

$ cmake -D CMAKE_BUILD_TYPE:String="Release" .

Changing Compiler

Set CC variable:

$ CC=/usr/bin/clang cmake ..

Tests

libyang includes several tests built with cmocka. The tests can be found in tests subdirectory and they are designed for checking library functionality after code changes.

The tests are by default built in the Debug build mode by running

$ make

In case of the Release mode, the tests are not built by default (it requires additional dependency), but it can be enabled via cmake option:

$ cmake -DENABLE_BUILD_TESTS=ON ..

Tests can be run by the make's test target:

$ make test

CMake Notes

Note that, with CMake, if you want to change the compiler or its options after you already ran CMake, you need to clear its cache first. For your convenience, this action is available as cclean target of the Makefile:

$ make cclean
$ CC=gcc CFLAGS='-fstack-protector-strong -Wa,--noexecstack' cmake ..