Before this commit, the API to work with RMLVO was quite minimal: it only uses raw strings from the `xkb_rule_names` struct. However: - it forces the users to deal with error-prone string formatting; - it does not enforce tying together layouts and variants; - it limits adding new features by requiring defining delimiter characters and the corresponding parsing. Added the following API: - `xkb_rmlvo_builder_new()` - `xkb_rmlvo_builder_append_layout()` - `xkb_rmlvo_builder_append_option()` - `xkb_rmlvo_builder_unref()` There is no intermediate `layout` nor `option` object, in order to to keep the API simple. The only foreseen extension is enabling configuring layout-specific options.
Fragments for the changelog
This directory contains fragments for the future NEWS file.
Introduction
We use towncrier to produce useful, summarized news files.
There are 3 sections types:
- API:
changes/api - Tools:
changes/tools - Build System:
changes/build
There are 4 news fragments types:
- Breaking changes:
.breaking - Deprecated:
.deprecated - New:
.feature - Fixes:
.bugfix
Adding a fragment
Add a short description of the change in a file changes/SECTION/ID.FRAGMENT.md,
where:
SECTIONandFRAGMENTvalues are described in the previous section.IDis the corresponding issue identifier on Github, if relevant. If there is no such issue, thenIDshould start with+and some identifier that make the file unique in the directory.
Examples:
- A bug fix for the issue #463 is an API change, so the corresponding file
should be named
changes/api/463.bugfix.md. - A new feature for tools like #448 corresponds to e.g.
changes/tools/+add-verbose-opt.feature.md.
Guidelines for the fragment files:
- Use the Markdown markup.
- Use past tense, e.g. “Fixed a segfault”.
- Look at the previous releases NEWS file for further examples.
Build the changelog
Install towncrier from Pypi:
python3 -m pip install towncrier
Then build the changelog:
# Only check the result. Useful after adding a new fragment.
towncrier build --draft --version 1.8.0
# Write the changelog & delete the news fragments
towncrier build --yes --version 1.8.0