| 1 | Odin Bug Report Generator Version 0.5.6
|
|---|
| 2 | =======================================
|
|---|
| 3 |
|
|---|
| 4 | 0. Disclaimer
|
|---|
| 5 | =============
|
|---|
| 6 |
|
|---|
| 7 | OdinBug is free, but copyrighted software. It is not guaranteed to fulfill
|
|---|
| 8 | any particular purpose. Use it at your own risk. It may be included free of
|
|---|
| 9 | charge with every application that comes with or makes use of Odin libraries.
|
|---|
| 10 | The current sourcecode is freely available upon request to the author.
|
|---|
| 11 |
|
|---|
| 12 | 1. Introduction
|
|---|
| 13 | ===============
|
|---|
| 14 |
|
|---|
| 15 | The main goal of this program is to make creating proper bug reports for Team
|
|---|
| 16 | Odin more comfortable.
|
|---|
| 17 |
|
|---|
| 18 | The reason I started to write this program was, that I saw every day that
|
|---|
| 19 | Sander van Leeuwen and other Team Odin members write emails, telling us users
|
|---|
| 20 | to bring in proper bug reports (I don't exclude myself).
|
|---|
| 21 |
|
|---|
| 22 | Well, I would like Sander and all the others to spend there time on Odin and
|
|---|
| 23 | not writing emails about things that should be a non-issue.
|
|---|
| 24 |
|
|---|
| 25 | 2. Installation
|
|---|
| 26 | ===============
|
|---|
| 27 |
|
|---|
| 28 | As OdinBug.EXE is written in VX-REXX it needs the VROBJ.DLL runtime.
|
|---|
| 29 |
|
|---|
| 30 | VROBJ.DLL can be found in the directory x:\IMAGES (x=CD-ROM drive) of your
|
|---|
| 31 | original Warp 4 CD-ROM and has to be copied into into d:\OS2\DLL
|
|---|
| 32 | (d=bootdrive), or somewhere else in your LIBPATH.
|
|---|
| 33 |
|
|---|
| 34 | There is also a VROBJ.WPI package at the following location:
|
|---|
| 35 |
|
|---|
| 36 | http://groups.yahoo.com/group/odinusers/files/vrobj.wpi
|
|---|
| 37 | ftp://ftp.os2.org/odin/weekly/vrobj.wpi
|
|---|
| 38 |
|
|---|
| 39 | This package can be installed the usual way using WarpIN.
|
|---|
| 40 |
|
|---|
| 41 | OdinBug comes in 3 different packages (only one has to be used):
|
|---|
| 42 |
|
|---|
| 43 | 1.) As part of the weekly build files. OdinBug is installed automatically with
|
|---|
| 44 | Odin.
|
|---|
| 45 | 2.) As a standalone WPI package. This package can be installed the usual way using
|
|---|
| 46 | WarpIN.
|
|---|
| 47 | 3.) As a standalone ZIP package. This should be unZIPped into the Odin-"Windows"
|
|---|
| 48 | directory. Putting it elsewhere is not recommended and cause unpredictable
|
|---|
| 49 | results.
|
|---|
| 50 |
|
|---|
| 51 | Whenever a new version of OdinBug is executed for the first time, it creates
|
|---|
| 52 | an object for itself (and a few others) in the Odin folder and associates
|
|---|
| 53 | odin32_?.log files with it. Now you can doubleclick on any odin32_?.log file
|
|---|
| 54 | and OdinBug is fired up.
|
|---|
| 55 |
|
|---|
| 56 | Note: XWorkplace users should create "Odin Log File" as a subtype of "Plain
|
|---|
| 57 | Text" and associate OdinBug with that filetype in order to have OdinBug as a
|
|---|
| 58 | default for Odin logfiles and your favorites text editor as additional
|
|---|
| 59 | editor/viewer.
|
|---|
| 60 |
|
|---|
| 61 | Before pressing "Create" for the first time you have to configure your email
|
|---|
| 62 | client on the "EMail" page.
|
|---|
| 63 |
|
|---|
| 64 | 3. WHAT IT DOES
|
|---|
| 65 |
|
|---|
| 66 | OdinBug presents a notebook of forms to fill in the information needed
|
|---|
| 67 | by Team Odin and generates a report that follows the standards defined by
|
|---|
| 68 | Team Odin (see Online help for details).
|
|---|
| 69 |
|
|---|
| 70 | Generally this program needs 1 file as input from the user:
|
|---|
| 71 |
|
|---|
| 72 | - the Odin log file: odin32_?.log
|
|---|
| 73 |
|
|---|
| 74 | Note: Only debug builds can create log files!!!
|
|---|
| 75 |
|
|---|
| 76 | It will try to determine the Odin buildfile automatically, but if this fails
|
|---|
| 77 | or OdinBug is unsure, it will prompt the user to enter a valid buildfile,
|
|---|
| 78 | too.
|
|---|
| 79 |
|
|---|
| 80 | As soon as the user has specified these files, all the other information is
|
|---|
| 81 | gathered from CONFIG.SYS, SYSLEVEL files, the WarpIN database, from ODIN.INI
|
|---|
| 82 | and also from the odin32_?.log files. Only minor adjustments should have to
|
|---|
| 83 | be made (especially from users with non-Scitech Display drivers).
|
|---|
| 84 |
|
|---|
| 85 | It also scans the odin_?.log file to find the exception information and the
|
|---|
| 86 | stack dump in case an application traps. Be aware that these logfiles can
|
|---|
| 87 | become quite large and that it might take a while until processing is
|
|---|
| 88 | complete.
|
|---|
| 89 |
|
|---|
| 90 | The exception is presented on the exceptions page of OdinBug.
|
|---|
| 91 |
|
|---|
| 92 | 4. USAGE
|
|---|
| 93 |
|
|---|
| 94 | OdinBug is quite self explanatory anyway and there is a full featured
|
|---|
| 95 | online help and manual available. Please, read it!
|
|---|
| 96 |
|
|---|
| 97 | 5. BUG REPORTS AND FEATURE REQUESTS FOR THIS PROGRAM (OdinBug)
|
|---|
| 98 |
|
|---|
| 99 | Just email *me* and tell me what you think or what you would like to see! I
|
|---|
| 100 | will try to implement or fix it.
|
|---|
| 101 |
|
|---|
| 102 |
|
|---|
| 103 | 6. AUTHOR:
|
|---|
| 104 |
|
|---|
| 105 | Herwig Bauernfeind, 05-03-2002
|
|---|
| 106 | EMail: herwig.bauernfeind@aon.at
|
|---|
