From f25e5d9ec3cd8a3f425385f4c2b0b8dc606f5ad1 Mon Sep 17 00:00:00 2001 From: Cagebreak Signing Key 1 Date: Wed, 1 Apr 2020 11:01:27 +0000 Subject: [PATCH] Prepare 1.1.0 release - adjust versions - adapt documentation --- Bugs.md | 2 +- README.md | 27 +++++++++++++++++++----- man/cagebreak-config.5.md | 20 ++++++++---------- man/cagebreak.1.md | 2 +- meson.build | 2 +- signatures/{cagebreak.sig => 1.0.6.sig} | Bin 6 files changed, 34 insertions(+), 19 deletions(-) rename signatures/{cagebreak.sig => 1.0.6.sig} (100%) diff --git a/Bugs.md b/Bugs.md index 835fc94..b34f4f6 100644 --- a/Bugs.md +++ b/Bugs.md @@ -59,7 +59,7 @@ Steps to reproduce: ### Issue 4 github issue number: #1 - Fixed: 1.0.7 + Fixed: 1.1.0 This issue is code duplication in `parse.c`. diff --git a/README.md b/README.md index c793ac0..953a7d5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Cagebreak: A Wayland Tiling Compositor Inspired by Ratpoison This is Cagebreak, a Wayland tiling compositor. The goal of this project is to -provide a successor to ratpoison for wayland users. However, this is +provide a successor to ratpoison for Wayland users. However, this is no reimplementation of ratpoison. Should you like to know if a feature will be implemented, open an issue or get in touch with the development team. @@ -83,7 +83,7 @@ git tag -v version git push --tags origin master ``` -and a log message roughly describing the features is added in the commit. +and a log message roughly describing the features added in the commit. In the past, our git history did not always reflect this scheme. @@ -94,8 +94,9 @@ Release checklist * [ ] Cursory testing * [ ] libfuzzer testing * [ ] Version Number - * [ ] -v flag + * [ ] meson.build * [ ] git tag + * [ ] man pages * [ ] Relevant Documentation * [ ] New features documented * [ ] man page @@ -131,7 +132,7 @@ The full public keys can be found in `keys/` along with any revocation certifica Cagebreak offers reproducible builds given the exact library versions specified in `meson.build`. Should a version mismatch occur, a warning will be emitted. We have decided on this compromise to allow flexibility and security. In general we will -adapt the versions to the packages available under archlinux at the time of +adapt the versions to the packages available under arch linux at the time of release. #### Reproducible Build Instructions @@ -163,12 +164,28 @@ will be named after their release version. Along with the project source code, a fuzzing framework based on `libfuzzer` is supplied. This allows for the testing of the parsing code responsible for reading -the `cagebreak` configuration file. When the `libfuzzer` is available (please +the `cagebreak` configuration file. When `libfuzzer` is available (please use the `clang` compiler to enable it), building the fuzz-testing software can be enabled by passing `-Dfuzz=true` to meson. This generates a `build/fuzz/fuzz-parse` binary according to the `libfuzzer` specifications. Further documentation on how to run this binary can be found [here](https://llvm.org/docs/LibFuzzer.html). +Here is an example workflow: + +``` +rm -rf build +CC=clang meson build -Dfuzz=true +ninja -C build/ +mkdir build/fuzz_corpus +cp examples/config build/fuzz_corpus/ +WLR_BACKENDS=headless ./build/fuzz/fuzz-parse -jobs=12 -max_len=50000 -close_fd_mask=3 build/fuzz_corpus/ +``` + +You may want to tweak `-jobs` or add other options depending on your own setup. +We have found code path discovery to increase rapidly when the fuzzer is supplied +with an initial config file. We are working on improving our fuzzing coverage to +find bugs in other areas of the code. + ## Bugs For any bug, please [create an diff --git a/man/cagebreak-config.5.md b/man/cagebreak-config.5.md index bbf3096..eebeda2 100644 --- a/man/cagebreak-config.5.md +++ b/man/cagebreak-config.5.md @@ -1,4 +1,4 @@ -% CAGEBREAK-CONFIG(1) Version 1.0 | Cagebreak Manual +% CAGEBREAK-CONFIG(1) Version 1.1 | Cagebreak Manual # NAME @@ -21,16 +21,16 @@ by prepending a line with the # symbol. **background - Set background color** > Set the background color. This command expects three floating point numbers -> between 0 and 1, specifying the r,g and b values respectively. +> between 0 and 1, specifying the r, g and b values respectively. > (e.g. "background 1.0 0.0 0.0" sets to background color to red) > There is no support for specifying a background image. -**bind - Bind key to action in command mode** +**bind - Bind key to command in root mode** -> This command requires a key (see **KEY DEFINITIONS**) and an action (see **ACTIONS**) as an argument. +> This command requires a key (see **KEY DEFINITIONS**) and a command (see **COMMANDS**) as an argument. > Subsequently, pressing this key while in command mode executes the -> supplied action. `bind ` is equivalent to -> `definekey root ` +> supplied action. `bind ` is equivalent to +>> `definekey root ` **definekey - Bind key to action in arbitrary mode** @@ -38,13 +38,13 @@ by prepending a line with the # symbol. > difference that the mode in which the keybinding is activated is > specified by the user. A call to this function is to be structured as follows: > ->> `definekey ` +>> `definekey ` **definemode** > This command requires a single argument; the name of the mode to be defined. > Subsequent to a call to this function, the defined mode may be used along with -> the definekey command to create a custom keymapping. Synopsis: +> the definekey command to create a custom key mapping. Synopsis: > >> `definemode ` @@ -64,8 +64,6 @@ by prepending a line with the # symbol. > Requires a single integer larger than 1 and less than 30 as an argument. Sets the number of > workspaces to the supplied number -# ACTIONS - **vsplit** > Split current tile vertically @@ -100,7 +98,7 @@ by prepending a line with the # symbol. **abort** -> Return to the default mode without running any action +> Return to the default mode without running any command **time** diff --git a/man/cagebreak.1.md b/man/cagebreak.1.md index 6d5b051..cacd1c2 100644 --- a/man/cagebreak.1.md +++ b/man/cagebreak.1.md @@ -1,4 +1,4 @@ -% CAGEBREAK(1) Version 1.0 | Cagebreak Manual +% CAGEBREAK(1) Version 1.1 | Cagebreak Manual # NAME diff --git a/meson.build b/meson.build index 0bf6076..959d35f 100644 --- a/meson.build +++ b/meson.build @@ -1,5 +1,5 @@ project('cagebreak', 'c', - version: '1.0.7', + version: '1.1.0', license: 'MIT', default_options: [ 'c_std=c11', diff --git a/signatures/cagebreak.sig b/signatures/1.0.6.sig similarity index 100% rename from signatures/cagebreak.sig rename to signatures/1.0.6.sig