Skip to content
This repository has been archived by the owner on Feb 16, 2025. It is now read-only.

Commit

Permalink
Merge pull request #3166 from sanssecours/🔗
Browse files Browse the repository at this point in the history
Documentation: Fix Broken Link
  • Loading branch information
markus2330 authored Nov 6, 2019
2 parents 82663a3 + 5392c73 commit 69b1e93
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 33 deletions.
50 changes: 25 additions & 25 deletions doc/news/_preparation_next_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,53 +84,53 @@ plugins. _(René Schwaiger)_
of the string in `argv`. _(Klemens Böswirth)_
- Increase test timeout from 120s to 240s. _(Mihael Pranjić)_

### Mmapstorage

- We now store the OPMPHM inside of the mmap format. _(Mihael Pranjić)_
- The storage format was changed and many sanity checks were improved or added. _(Mihael Pranjić)_
- Enforce consistency by writing the magic file footer last. _(Mihael Pranjić)_

### Noresolver

- The plugin now correctly sets the path in the `parentKey`. It therefore now supports set calls. _(Klemens Böswirth)_

### Path

- The [Markdown Shell Recorder][] test of the plugin now also works, if you execute it as root user. _(René Schwaiger)_

[markdown shell recorder]: https://master.libelektra.org/tests/shell/shell_recorder/tutorial_wrapper

### Tcl
### Spec

- We made sure that building the plugin works, if you use the latest version of CMake (`3.15.3`) and Boost (`1.71`). _(René Schwaiger)_
- There is now the config key `missing/log` that allows logging of all missing `require`d keys. _(Klemens Böswirth)_
- `spec` now internally handles errors differently. There should be no external impact apart from better performance. _(Klemens Böswirth)_

### YAwn
### Specload

- We removed the plugin in favor of [Yan LR](../../src/plugins/yanlr/README.md). _(René Schwaiger)_
- We now treat relative paths as relative to `KDB_DB_SPEC` instead of the current working directory. _(Klemens Böswirth)_
- Changes to `default` or `type` metadata are no longer supported, since they are not safe in every case. _(Klemens Böswirth)_
- The plugin no longer has the `experimental` status. _(Klemens Böswirth)_

### YAy PEG
### Tcl

- We removed the plugin in favor of [Yan LR](../../src/plugins/yanlr/README.md). _(René Schwaiger)_
- We made sure that building the plugin works, if you use the latest version of CMake (`3.15.3`) and Boost (`1.71`). _(René Schwaiger)_

### Type

- We added an option to disable the restoring of boolean values. This useful for storage formats like YAML that have
native boolean types. _(Klemens Böswirth)_

### Mmapstorage

- We now store the OPMPHM inside of the mmap format. _(Mihael Pranjić)_
- The storage format was changed and many sanity checks were improved or added. _(Mihael Pranjić)_
- Enforce consistency by writing the magic file footer last. _(Mihael Pranjić)_

### Noresolver

- The plugin now correctly sets the path in the `parentKey`. It therefore now supports set calls. _(Klemens Böswirth)_

### Specload
### Yajl

- We now treat relative paths as relative to `KDB_DB_SPEC` instead of the current working directory. _(Klemens Böswirth)_
- Changes to `default` or `type` metadata are no longer supported, since they are not safe in every case. _(Klemens Böswirth)_
- The plugin no longer has the `experimental` status. _(Klemens Böswirth)_
- Yajl now correctly supports Elektras boolean types using the `type` plugin. For example, setting `on`, `enable` or `true` all map to JSONs native `true` value. See the [type](../../src/plugins/type/README.md) plugin for more details about boolean types. _(Philipp Gackstatter)_

### Spec
### YAwn

- There is now the config key `missing/log` that allows logging of all missing `require`d keys. _(Klemens Böswirth)_
- `spec` now internally handles errors differently. There should be no external impact apart from better performance. _(Klemens Böswirth)_
- We removed the plugin in favor of [Yan LR](../../src/plugins/yanlr/README.md). _(René Schwaiger)_

### Yajl
### YAy PEG

- Yajl now correctly supports Elektras boolean types using the `type` plugin. For example, setting `on`, `enable` or `true` all map to JSONs native `true` value. See the [type](../../src/plugins/type/README.md) plugin for more details about boolean types. _(Philipp Gackstatter)_
- We removed the plugin in favor of [Yan LR](../../src/plugins/yanlr/README.md). _(René Schwaiger)_

## Libraries

Expand Down
31 changes: 27 additions & 4 deletions src/plugins/yanlr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,39 @@ This plugin uses ANTLR to generate a parser for the [YAML](http://yaml.org) seri

The plugin requires

- [ANTLR](https://www.antlr.org) `4.6` or later ([`antlr4`](https://repology.org/metapackage/antlr4)), and
- [ANTLR 4’s C++ runtime](https://github.com/antlr/antlr4/tree/master/runtime/Cpp)
([`antlr4-cpp-runtime`](https://repology.org/metapackage/antlr4-cpp-runtime) or [`libantlr4-runtime-dev`](https://packages.debian.org/search?searchon=names&keywords=libantlr4-runtime-dev))
- [ANTLR](https://www.antlr.org) `4.6` or later, and
- [ANTLR 4’s C++ runtime](https://github.com/antlr/antlr4/tree/master/runtime/Cpp).

. If packages for those libraries are not available for your system, you can install them manually. For more information about that please
If packages for those libraries are not available for your system, you can install them manually. For more information about that please
take a look [at ANTLR’s homepage](https://www.antlr.org) and at the
[ReadMe of the ANTLR C++ runtime](https://github.com/antlr/antlr4/tree/master/runtime/Cpp).

Please note that we only tested the plugin with ANTLR `4.7.1` (and later versions of ANTLR).

### Arch Linux

In [Arch Linux](https://www.archlinux.org) the required packages are called [`antlr4`](https://www.archlinux.org/packages/extra/any/antlr4) and [`antlr4-runtime`](https://www.archlinux.org/packages/community/x86_64/antlr4-runtime).

```
pacman -Sy --noconfirm antlr4 antlr4-runtime
```

### Debian Linux

In Debian Linux you need the packages [`antlr4`](https://packages.debian.org/sid/antlr4) and [`libantlr4-runtime-dev`](https://packages.debian.org/sid/libantlr4-runtime-dev).

```
apt-get -y install antlr4 libantlr4-runtime-dev
```

### macOS

To install the dependencies of the plugin using [Homebrew](https://brew.sh), please use the command below.

```
brew install antlr antlr4-cpp-runtime
```

## Examples

### Mappings
Expand Down
4 changes: 0 additions & 4 deletions tests/linkchecker.whitelist
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,3 @@ https://webdemo.libelektra.org
https://debian-stretch-repo.libelektra.org
https://crates.io/crates/elektra
https://crates.io/crates/elektra-sys
http://standards.freedesktop.org/basedir-spec/basedir-spec-0.8.html
http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
https://freedesktop.org
https://www.freedesktop.org/wiki/Software/pkg-config

0 comments on commit 69b1e93

Please sign in to comment.