mirrors/sway
1
0
Fork 0
mirror of https://github.com/swaywm/sway.git synced 2024-11-22 07:51:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove HACKING.md

Browse source 
Half of this is outdated and the other half is questionable.
This commit is contained in:
Drew DeVault 2018-10-03 08:02:46 -04:00
parent e60ad3f677
commit 54a835e962
1 changed files with 0 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
HACKING.md
View file

@ -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.