Elektra  0.8.26
0.8.26 Release

This release did not happen yet.

Please update this file within PRs accordingly. For non-trivial changes, you can choose to be part of the highlighted changes. Please make sure to add some short tutorial (checked by shell recorder) or asciinema for highlighted items.

Please add your name at the end of every contribution. Syntax: _(your name)_

<<scripts/generate-news-entry>>

We are proud to release Elektra 0.8.26 with the new high-level API.

What is Elektra?

Elektra serves as a universal and secure framework to access configuration settings in a global, hierarchical key database. For more information, visit https://libelektra.org.

You can also read the news on our website

High-Level API

The new high-level API provides an easier way for applications to get started with Elektra.

To use Elektra in an application (including proper error handling) you now only need a few self-explanatory lines of code:

ElektraError * error = NULL;
Elektra * elektra = elektraOpen ("/sw/org/myapp/#0/current", NULL, &error);
if (elektra == NULL)
{
printf ("An error occurred: %s", elektraErrorDescription (error));
elektraErrorReset (&error);
return -1;
}
// Once you have an instance of `Elektra` you simply call one of the typed `elektraGet*` functions to read a value:
kdb_long_t mylong = elektraGetLong (elektra, "mylong");
printf ("got long " ELEKTRA_LONG_F "\n", mylong);
const char * mystring = elektraGetString (elektra, "mystring");
printf ("got string %s\n", mystring);
elektraClose (elektra);

To run the application, the configuration should be specified, e.g., for mylong:

sudo kdb setmeta /sw/org/myapp/#0/current/mylong type long
sudo kdb setmeta /sw/org/myapp/#0/current/mylong default 5

In the getters/setters there is no need to specify the base path /sw/org/myapp/#0/current anymore, as the high-level API keeps track of that for you. The API supports the CORBA types already used the plugins. The high-level API should also be used in combination with a specification (spec-mount). When used this way, the API is designed to be error and crash free while reading values. Writing values, can of course still produce errors.

Another advantage of the new API is, that it will be much easier to write bindings for other languages now, because only a few simply types and functions have to be mapped to provide the full functionality.

Take a look at the README for more infos.

For an example on how to build an application using this API take a look at this. _(Klemens Böswirth)_

Plugins

The following section lists news about the modules we updated in this release.

Augeas

Network

YAMBi

YanLR

key: - element 1
- element 2 # Incorrect Indentation!

the plugin currently prints an error message that looks like this:

config.yaml:2:1: mismatched input '- ' expecting end of map
- element 2 # Incorrect Indentation!
^^
config.yaml:2:37: extraneous input 'end of map' expecting end of document
- element 2 # Incorrect Indentation!
^

. The inspiration for this feature was taken from the book “The Definitive ANTLR 4 Reference” by Terence Parr. _(René Schwaiger)_

Path

Enhanced the plugin to also check for concrete file or directory permissions such as rwx. You can specify for example that a user can write to a certain directory or file which prevents applications of runtime failures once they try to access the given path (such as a log directory or file). Simply add check/path/user <user> and check/path/mode <modes> as metadata and be assured that you can safely set a path value to the key. A more detailed explanation can be found here _(Michael Zronek)_

YAwn

YAy PEG

Ruby

Misc

Libraries

The text below summarizes updates to the C (and C++)-based libraries of Elektra.

Compatibility

As always, the ABI and API of kdb.h is fully compatible, i.e. programs compiled against an older 0.8 version of Elektra will continue to work (ABI) and you will be able to recompile programs without errors (API).

Core

Libease

elektraArrayValidateBaseNameString ("#_10");
// ~~^ Returns `2` (instead of `1`)
elektraArrayValidateBaseNameString ("#___1337");
// ~~~~^ Returns `4` (instead of `1`)

If your program already used elektraArrayValidateBaseNameString and you check for a valid array element using the equality operator (== 1), then please use (>= 1) instead. For example, if you code that looks like this:

if (elektraArrayValidateBaseNameString(baseName) == 1) …;

, please update your code to check for a valid array element name like this:

if (elektraArrayValidateBaseNameString(baseName) >= 1) …;

. _(René Schwaiger)_

Libopts

Tools

Scripts

Documentation

Tests

Build

CMake

Misc

Find Modules

Docker

Misc

Infrastructure

Cirrus

Jenkins

Travis

Website

The website is generated from the repository, so all information about plugins, bindings and tools are always up to date.

Outlook

We are currently working on following topics:

Statistics

Following authors made this release possible:

<<scripts/git-release-stats 0.8.26>>

Join the Initiative!

We welcome new contributors! Read here about how to get started.

As first step, you could give us feedback about these release notes. Contact us via the issue tracker.

Get the Release!

You can download the release from here or GitHub

The hashsums are:

<<scripts/generate-hashsums>>

The release tarball is also available signed by Markus Raab using GnuPG from here or on GitHub

Already built API-Docu can be found here or on GitHub.

Stay tuned!

Subscribe to the RSS feed to always get the release notifications.

If you also want to participate, or for any questions and comments please contact us via the issue tracker on GitHub.

Permalink to this NEWS entry

For more information, see https://libelektra.org

Best regards, Elektra Initiative

Generated by   doxygen 1.8.13