aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Drew DeVault <sir@cmpwn.com>2018-10-03 08:02:46 -0400
committerLibravatar Drew DeVault <sir@cmpwn.com>2018-10-03 08:02:46 -0400
commit54a835e962b45683e1def4a9aaf1c1371fb4aa28 (patch)
tree10a0b281ae4bbb70d366048cecd392a81ea31a65
parentFix some missing commands in sway-input(5) (diff)
downloadsway-54a835e962b45683e1def4a9aaf1c1371fb4aa28.tar.gz
sway-54a835e962b45683e1def4a9aaf1c1371fb4aa28.tar.zst
sway-54a835e962b45683e1def4a9aaf1c1371fb4aa28.zip
Remove HACKING.md
Half of this is outdated and the other half is questionable.
-rw-r--r--HACKING.md24
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
3Use `sway_log(importance, fmt, ...)` to log. The following importances are
4available:
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
11number, which are written into the log with your message.
12
13## Assertions
14
15In the compositor, assertions *must not* be fatal. All error cases must be
16handled as gracefully as possible - crashing the compositor will make the user
17lose all of their work.
18
19Use `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
21assertion fails.
22
23Outside of the compositor (swaymsg, swaybar, etc), using `assert.h` is
24permitted.