From 54a835e962b45683e1def4a9aaf1c1371fb4aa28 Mon Sep 17 00:00:00 2001 From: Drew DeVault Date: Wed, 3 Oct 2018 08:02:46 -0400 Subject: [PATCH] Remove HACKING.md Half of this is outdated and the other half is questionable. --- HACKING.md | 24 ------------------------ 1 file changed, 24 deletions(-) delete mode 100644 HACKING.md diff --git a/HACKING.md b/HACKING.md deleted file mode 100644 index 8965d3ec6..000000000 --- a/HACKING.md +++ /dev/null @@ -1,24 +0,0 @@ -## Logging - -Use `sway_log(importance, fmt, ...)` to log. The following importances are -available: - -* `WLR_DEBUG`: Debug messages, only shows with `sway -d` -* `WLR_INFO`: Informational messages -* `WLR_ERROR`: Error messages - -`sway_log` is a macro that calls `_sway_log` with the current filename and line -number, which are written into the log with your message. - -## Assertions - -In the compositor, assertions *must not* be fatal. All error cases must be -handled as gracefully as possible - crashing the compositor will make the user -lose all of their work. - -Use `sway_assert(condition, fmt, ...)` to perform an assertion. This returns -`condition`, which you must handle if false. An error will be logged if the -assertion fails. - -Outside of the compositor (swaymsg, swaybar, etc), using `assert.h` is -permitted.