Skip to content

Commit d5d2f60

Browse files
committedSep 22, 2011
Bill von Hagen's suggestions for DEBUG.mk
1 parent 8a716a0 commit d5d2f60

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed
 

‎DEBUGGING.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33

44
Thank you for considering helping me debug a problem with [It's All Text!](http://github.com/docwhat/itsalltext).
55

6-
This document will help you set up debugging and then remove it once you're done. You'll probably want to remove some of these debugging methods when you finish because it slows down Firefox. Unless you debug regularly (you're a web or extension developer) you probably don't need these tools day-to-day.
6+
This document will help you set up debugging and then remove it once you're done. You'll probably want to undo some of the debugging when you finish because it slows down Firefox. Unless you debug regularly (you're a web or extension developer) you probably don't need these tools day-to-day.
77

88
## Preparation
99

1010
You may want to save a copy of this document to disk or open it in a different browser so you can read it while you're restarting and debugging Firefox.
1111

12-
You'll also want at text editor or an open email to collect any interesting information.
12+
You'll also want a text editor or a new open email to collect any interesting information.
1313

1414
### Setting up a new profile (optional)
1515

@@ -19,12 +19,12 @@ There are several advantages to setting up a new profile for debugging IAT:
1919

2020
1. You won't change your normal settings.
2121
2. Cleanup is easy, just switch profiles back to your normal profile.
22-
3. It makes debugging problems caused by extensions interacting with IAT.
22+
3. It makes debugging problems caused by extensions interacting with IAT possible without destroying your day-to-day profile.
2323
4. You start with default settings for your platform.
2424

2525
If this sounds good to you, then go read the [managing profiles article](http://support.mozilla.com/en-US/kb/Managing-profiles) in the Mozilla knowledge-base.
2626

27-
Once you've set up a new debugging profile and are running it by restarting Firefox, then you'll want to go install the version of It's All Text! you'll be debugging. You should have either gotten an `.xpi` file directly from Christian Höltje or you can get any previously released version from [Addons.Mozzilla.Org](https://addons.mozilla.org/en-US/firefox/addon/its-all-text/versions/).
27+
Once you've set up a new debugging profile and are running it by restarting Firefox and activating that profile you'll want to go install the version of It's All Text! you'll be debugging. You should have either gotten an `.xpi` file directly from Christian Höltje or you can get any previously released version from [Addons.Mozilla.Org](https://addons.mozilla.org/en-US/firefox/addon/its-all-text/versions/).
2828

2929
The TL;DR version is to run the following command (for Windows and Linux only, alas):
3030

@@ -48,13 +48,13 @@ You open the Error Console via <kbd>CTRL</kbd>+<kbd>SHIFT</kdb>+<kbd>J</kbd>.
4848

4949
1. Verify that it is set to show "all" errors, messages, etc. Click the "all" tab/button.
5050
2. Check the Error Console for any errors from It's All Text! during startup. If there are any, then you should copy and paste them into your notes and mark them as start-up errors.
51-
3. Clear the console. This is to make finding problems easier.
51+
3. Clear the console. This is to make finding subsequent problems easier.
5252

5353
### Debug
5454

5555
If you're debugging "normal usage" of IAT, then you can go to [http://docwhat.org/files/iat] and walk through those tests one by one.
5656

57-
After each step check your Error Console and see if any errors from IAT have appeared. Make note of any that do appear. It's okay to record too much, we can clean up the info later.
57+
After each step check your Error Console and see if any errors from IAT have appeared and make a note of them. It's okay to record too much, we can clean up the info later.
5858

5959
You may want to clear the Error Console regularly to make finding new messages easier.
6060

@@ -155,6 +155,10 @@ If you're proficient enough to do this, I won't need to explain too much to you.
155155

156156
You'll also want to install [Venkman](https://developer.mozilla.org/en/Venkman), even if you use Firebug to do JS debugging.
157157

158+
Since you are knowledgable enough to be using a debugger, I assume you'll figure out how to continue from here.
159+
160+
The latest source (and tagged releases) are all on [github](http://github.com/docwhat/itsalltext).
161+
158162
## Getting Help
159163

160164
You can contact me via [email](http://docwhat.org/email/) or via IM or IRC. See [my homepage](http://docwhat.org/) for my "Alter Egos" (in the sidebar) to find a way to talk to me directly.

0 commit comments

Comments
 (0)
Please sign in to comment.