emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs/getting_started: remove markdown-isms

Browse source
This commit is contained in:
Henrik Lissner 2019-11-09 11:51:28 -05:00
parent a55b5a4514
commit 5b5c7cbaff
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
1 changed files with 11 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/getting_started.org
View file

@ -59,8 +59,8 @@
- [[#variables-functions-faces-etc][Variables, functions, faces, etc.]] - [[#variables-functions-faces-etc][Variables, functions, faces, etc.]]
- [[#for-doom-modules-packages-autodefs-etc][For Doom Modules, packages, autodefs, etc.]] - [[#for-doom-modules-packages-autodefs-etc][For Doom Modules, packages, autodefs, etc.]]
- [[#how-to-extract-a-backtrace-from-an-error][How to extract a backtrace from an error]] - [[#how-to-extract-a-backtrace-from-an-error][How to extract a backtrace from an error]]
- [[#enabling-debug-on-error][Enabling `debug-on-error`]] - [[#enabling-debug-on-error][Enabling ~debug-on-error~]]
- [[#a-backtrace-from-bindoom][A backtrace from `bin/doom`]] - [[#a-backtrace-from-bindoom][A backtrace from ~bin/doom~]]
- [[#evaluating-elisp-on-the-fly][Evaluating Elisp on-the-fly]] - [[#evaluating-elisp-on-the-fly][Evaluating Elisp on-the-fly]]
- [[#how-to-determine-the-origin-of-a-bug][How to determine the origin of a bug]] - [[#how-to-determine-the-origin-of-a-bug][How to determine the origin of a bug]]
- [[#testing-in-dooms-sandbox][Testing in Doom's sandbox]] - [[#testing-in-dooms-sandbox][Testing in Doom's sandbox]]
@ -1080,24 +1080,23 @@ You can also evaluate code with ~eval-expression~ (=M-;= or =SPC ;=).
** How to extract a backtrace from an error ** How to extract a backtrace from an error
If you encounter an error while using Doom Emacs, you're probably about to head If you encounter an error while using Doom Emacs, you're probably about to head
off and file a bug report (or request help on [[[https://discord.gg/bcZ6P3y][our Discord server]]. Before you do, off and file a bug report (or request help on [[https://discord.gg/bcZ6P3y][our Discord server]]). Before you
please generate a backtrace to include with it. do, please generate a backtrace to include with it.
To do so you must enable ~debug-on-error~ then recreate the error. To do so you must enable ~debug-on-error~ then recreate the error.
*** Enabling `debug-on-error` *** Enabling ~debug-on-error~
There are three ways to enable `debug-on-error`: There are three ways to enable ~debug-on-error~:
1. Start Emacs with `emacs --debug-init`. Use this for errors that occur at 1. Start Emacs with ~emacs --debug-init~. Use this for errors that occur at
startup. startup.
2. Evil users can press <kbd>SPC h d d</kbd> and non-evil users can press 2. Evil users can press =SPC h d d= and non-evil users can press =C-h d d=.
=C-h d d=. 3. If the above don't work, there's always: ~M-x toggle-debug-on-error~
3. If the above don't work, there's always: `M-x toggle-debug-on-error`
Now that `debug-on-error` is on, recreate the error. A window should pop up with Now that ~debug-on-error~ is on, recreate the error. A window should pop up with
a backtrace. a backtrace.
*** A backtrace from `bin/doom` *** A backtrace from ~bin/doom~
If the error you've encountered is emitted from ~bin/doom~, you can re-run the If the error you've encountered is emitted from ~bin/doom~, you can re-run the
same command with the ~-d~ or ~--debug~ switches to force it to emit a backtrace same command with the ~-d~ or ~--debug~ switches to force it to emit a backtrace
when an error occurs. The ~DEBUG~ environment variable will work to. when an error occurs. The ~DEBUG~ environment variable will work to.