Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Revamp of debug script with logic and colours #1565
By submitting this pull request, I confirm the following (please check boxes, eg [X]) Failure to fill the template will close your PR:
Please submit all pull requests against the
How familiar are you with the codebase?:
This is an attempt to make the debug log easier to read and to disseminate the information it contains--with the end goal being that users will be able to help themselves based on the output of the script. As much as we try to help every user who has a question, we're all volunteering our time, so if the user can run the debug script and self-diagnose the issue, not only will they learn something, but can hopefully fix any issue they may run into by following the URLs the script provides.
The script will:
In addition to the revamp, detailed comments are included on nearly every line. Pi-hole is a great beginners project (especially in the RPi-realm) and we want Pi-hole to be a project people feel they can contribute to. To that end, each portion of code is explained so someone trying to learn about shell scripts can use our project as a springboard.
Intensive testing should be done on this before merging as the variety of systems and issues people may run into are difficult for one person to recreate.
And it's been a while since I've coded anything so forgive any rustiness you may find... and feel free to add any changes you see fit.
This template was created based on the work of
referenced this pull request
Jun 30, 2017
Jul 5, 2017
5 checks passed
This was referenced
Jul 7, 2017
This pull request has been mentioned on Pi-hole Userspace. There might be relevant details there: