Rooba
/
polybar
mirror of https://github.com/polybar/polybar.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update debugging guide

patrick96 2022-03-07 21:34:52 +01:00
parent cadfbf02e8
commit 8452ed4e48
No known key found for this signature in database
GPG Key ID: 521E5E03AEBCA1A7
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Debugging-your-Config.md

@ -33,9 +33,10 @@ modules are not displayed.
*If the step above already gave you a concrete location for where your problem is, you may skip this section. But come
back to it if you open a new issue.*
Now we need to figure out where exactly the issue lies. This will make it easier for you to diagnose and fix the it.
Now we need to figure out where exactly the issue lies. This will make it easier for you to diagnose and fix the issue.
We do this with a so called *Minimal, Complete, and Verifiable example* ([mcve](https://stackoverflow.com/help/mcve)).
The idea is to create a setup where you still have the same problems but with all unnecessary parts stripped out.
The idea is to create a setup where you still have the same problems but with
all unnecessary parts (especially modules) stripped out.
Note that you should not only make your config minimal but also your startup routine, preferably you should start a
single polybar instance from the terminal.
The act of finding such a minimal example may already help you track down the source of your problem.
@ -45,10 +46,10 @@ try to run polybar directly from the terminal. If polybar starts from the termin
with your WM startup routine is causing issues. If it doesn't start, you know the problem lies somewhere else. Without
this information you might end up spending a lot of time searching in the wrong places.
Such an MCVE is not only helpful to you but also to people you might end up asking for help. No one wants to see errors
about your missing custom scripts when they help you debug issues with the pulseaudio module. It also shows that you
have invested time to try and fix the problem yourself and because of that people may be more inclined to help you than
when you just drop 200 lines of configs on them with the comment "It doesn't work".
Such an MCVE is not only helpful to you but also to people you might end up asking for help.
No one wants to see errors about your missing custom scripts when they help you debug issues with the pulseaudio module.
It also shows that you have invested time to try and fix the problem yourself
and because of that people may be more inclined to help you.
## Read the Documentation