Updated 5.2 Troubleshooting (markdown)

Thorin-Oakenpants 2022-02-06 15:15:49 +00:00
parent d2e1931eb6
commit 4ef25c6008

@ -1,6 +1,6 @@
#### 🟩 FOREWORD
Before opening a [new troubleshooting issue](https://github.com/arkenfox/user.js/issues/new?assignees=&labels=&template=troubleshooting-help.md&title=), do some CHECKS and CONFIRM the problem is caused by arkenfox.
Before opening a [new troubleshooting issue](https://github.com/arkenfox/user.js/issues/new?assignees=&labels=&template=troubleshooting-help.md&title=), do some CHECKS and CONFIRM the problem is caused by an arkenfox pref(s).
---
@ -18,12 +18,12 @@ Before opening a [new troubleshooting issue](https://github.com/arkenfox/user.js
<sup>1</sup> PARROTS
When you modify your user.js, such as adding any overrides, sometimes syntax errors happen. Open about:config and check your `"parrot"`. Arkenfox uses `_user.js.parrot` throughout the user.js. You can use any pref name you like, as long as it's different (to avoid confusion).
When you modify your user.js, such as adding any overrides, sometimes syntax errors happen. Open about:config and check your `"parrot"`. Arkenfox uses `_user.js.parrot` throughout the user.js, but use any pref name you like for your overrides
> ```js
> /* my overrides */
> user_pref("canary.in.a.coalmine", "overrides: started"); // parrot, canary, whatever you like
> user_pref("_overrides.parrot", "overrides: started");
> user_pref("pref.name.example", "green"); // I like green
> user_pref("canary.in.a.coalmine", "overrides: success");
> user_pref("_overrides.parrot", "overrides: success");
> ```
[Not all](https://blog.mozilla.org/nnethercote/2018/03/09/a-new-preferences-parser-for-firefox/) syntax errors cause the user.js parsing to be aborted. After Firefox opens, open the Browser Console (`Ctrl+Shift+J`) and check for any **pref-parsing related** warnings/errors
@ -34,13 +34,13 @@ When you modify your user.js, such as adding any overrides, sometimes syntax err
#### 🟪 CONFIRM
Confirm this is caused by arkenfox supported prefs in a new profile
Confirm your issue is caused by arkenfox supported prefs in a new profile.
- 🔹 NEW PROFILE: STEP ONE
- 🔹 IS IT UPSTREAM?
- No pref changes and no extensions (unless the problem being tested is the extension)
- If the problem still occurs, this is an upstream bug
- 🔹 NEW PROFILE: STEP TWO
- Add arkenfox (with relevant overrides if applicable <sup>1</sup>) and restart
- 🔹 IS IT ARKENFOX?
- Add arkenfox (with relevant overrides <sup>1</sup> if applicable) and restart
- If the problem doesn't occur, then the issue is not arkenfox
<sup>1</sup> Relevant overrides are those listed in arkenfox for users to implement: i.e not items listed as DON'T TOUCH or DON'T BOTHER
@ -60,24 +60,24 @@ To run the script:
#### 🟪 MANUAL
If arkenfox is confirmed as the cause, and you haven't found an existing answer, or you haven't found a console clue and tested some individual looking likely prefs, then you can do some manual testing to quickly narrow it down
If an arkenfox pref(s) is confirmed as the cause, and you haven't found an existing answer, or you haven't found a console clue and tested some individual looking likely prefs, then you can do some manual testing to quickly narrow it down.
TEST PROFILE
- 🔹 Create a new TEST profile with an empty `user.js`. Bookmark your test page(s), and add an extension if it is an extension issue that you are testing
- 🔹 Copy the TEST profile for quick restoring if needed
MANUAL
- 🔹 In the empty user.js, add the first section and save, restart, test
- 🔹 In the empty `user.js`, add the first section and save, restart, test
- 🔹 Repeat until the issue appears, now you know the section with the problematic pref
BINARY
- 🔸 Binary: you eliminate half the remaining suspects each time
- 🔹 In the empty user.js, add half of "your" `user.js` and save, restart Firefox and test
- 🔹 In the empty user.js, add half of "your" user.js and save, restart Firefox and test
- 🔹 If the problem exists, you know it was in the first half
- 🔸 Reset the profile, add half of the prefs tested
- 🔹 If the problem does not exist, you know it is in the second half
- 🔸 Don't reset the profile, just add half of the remaining prefs
- 🔹 Keep repeating these steps until you narrow it down
- 🔹 Repeat to narrow it down
PREF BY PREF
- 🔹 Once you have narrowed down the possible prefs, you can test by toggling each one in `about:config`