diff options
-rw-r--r-- | HACKING.md | 24 |
1 files changed, 0 insertions, 24 deletions
diff --git a/HACKING.md b/HACKING.md deleted file mode 100644 index 8965d3ec..00000000 --- a/HACKING.md +++ /dev/null | |||
@@ -1,24 +0,0 @@ | |||
1 | ## Logging | ||
2 | |||
3 | Use `sway_log(importance, fmt, ...)` to log. The following importances are | ||
4 | available: | ||
5 | |||
6 | * `WLR_DEBUG`: Debug messages, only shows with `sway -d` | ||
7 | * `WLR_INFO`: Informational messages | ||
8 | * `WLR_ERROR`: Error messages | ||
9 | |||
10 | `sway_log` is a macro that calls `_sway_log` with the current filename and line | ||
11 | number, which are written into the log with your message. | ||
12 | |||
13 | ## Assertions | ||
14 | |||
15 | In the compositor, assertions *must not* be fatal. All error cases must be | ||
16 | handled as gracefully as possible - crashing the compositor will make the user | ||
17 | lose all of their work. | ||
18 | |||
19 | Use `sway_assert(condition, fmt, ...)` to perform an assertion. This returns | ||
20 | `condition`, which you must handle if false. An error will be logged if the | ||
21 | assertion fails. | ||
22 | |||
23 | Outside of the compositor (swaymsg, swaybar, etc), using `assert.h` is | ||
24 | permitted. | ||