summaryrefslogtreecommitdiff
path: root/tmac/TESTING-HINTS
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2007-02-02 11:01:14 +0000
committerEric S. Raymond <esr@thyrsus.com>2007-02-02 11:01:14 +0000
commitf675d5f7d5bed7eb9be6b2bfc5575210a7d74845 (patch)
tree277241740c312a26f9f0008e2726933003f0db53 /tmac/TESTING-HINTS
parent5ee20325b59789e7dd76762f9f94afd5c3ebeed0 (diff)
downloadgroff-git-f675d5f7d5bed7eb9be6b2bfc5575210a7d74845.tar.gz
Added TESTING-HINTS based on wisdom from Werner.
Diffstat (limited to 'tmac/TESTING-HINTS')
-rw-r--r--tmac/TESTING-HINTS20
1 files changed, 20 insertions, 0 deletions
diff --git a/tmac/TESTING-HINTS b/tmac/TESTING-HINTS
new file mode 100644
index 000000000..5b51bef5d
--- /dev/null
+++ b/tmac/TESTING-HINTS
@@ -0,0 +1,20 @@
+Here are some hints about testing modifications to macro packages
+and manual pages.
+
+1. Use groff's `-ww' option to catch potential problems.
+ Ideally, there shouldn't be any warnings.
+
+2. For a well-formedness check, run doclifter (http://catb,org/~esr/doclifter)
+ against your page. This tool was written to lift pages to XML, but as a
+ side effect it acts as a validator that will warn you of potential problems
+ and non-portable constructs.
+
+3. The two most important groff client types are X terminal emulators
+ and Postscript printers. Eyeball-check your output under both.
+
+4. The colorized man output of the Midnight Commander (what you get by
+ pressing the F3 key on a man page) is good for making small errors
+ more visible.
+
+5. Try different terminal line lengths, say, 80 and 100 characters.
+