| 1 | Odin Bug Report Tool Version 0.5.0
|
|---|
| 2 | ==================================
|
|---|
| 3 |
|
|---|
| 4 | 0. DISCLAIMER
|
|---|
| 5 |
|
|---|
| 6 | OdinBug is free, but copyrighted software. It is not guaranteed
|
|---|
| 7 | to fulfill any particular purpose. Use it at your own risk. It may
|
|---|
| 8 | be included free of charge with every application that comes with
|
|---|
| 9 | Odin files.
|
|---|
| 10 |
|
|---|
| 11 | 1. INTRODUCTION
|
|---|
| 12 |
|
|---|
| 13 | The main goal of this program is to make creating proper bug reports
|
|---|
| 14 | for Team Odin quite comfortable. As it is in a rather early stage,
|
|---|
| 15 | please do not expect it to be bug free or feature complete!
|
|---|
| 16 |
|
|---|
| 17 | The reason I started to write this program was, that I see every day
|
|---|
| 18 | that Sander Van Leeuwen and other Team Odin members write emails, telling
|
|---|
| 19 | us users to bring in proper bug reports (I don't exclude myself).
|
|---|
| 20 |
|
|---|
| 21 | Well, I would like Sander and all the others to spend there time on
|
|---|
| 22 | Odin and not writing emails about things that should be a non-issue.
|
|---|
| 23 |
|
|---|
| 24 | 2. WHAT IT DOES
|
|---|
| 25 |
|
|---|
| 26 | This program presents a notebook of forms to fill in the information
|
|---|
| 27 | needed by Team Odin and generates a report that follows the standards
|
|---|
| 28 | presented in ReportingBugs.TXT which is part of every Odin build.
|
|---|
| 29 |
|
|---|
| 30 | Generally this program needs 2 files as input from the user:
|
|---|
| 31 |
|
|---|
| 32 | - the Odin build file: odin32bin-2001mmdd-debug.zip or
|
|---|
| 33 | odin32bin-2001mmdd-debug.wpi
|
|---|
| 34 |
|
|---|
| 35 | - the Odin log file: odin32_?.log
|
|---|
| 36 |
|
|---|
| 37 | Note: Only debug builds can create log files!!!
|
|---|
| 38 |
|
|---|
| 39 | As soon as the user specifies these files, all the other information
|
|---|
| 40 | is gathered from CONFIG.SYS, SYSLEVEL files, the WarpIN database, from
|
|---|
| 41 | ODIN.INI and also from the odin32_?.log files. Only minor adjustments
|
|---|
| 42 | should have to be made (especially from users with non-Scitech Display
|
|---|
| 43 | drivers).
|
|---|
| 44 |
|
|---|
| 45 | It also scans the odin_?.log file to find the exception information
|
|---|
| 46 | and the stack dump in case an application traps. Be aware that these
|
|---|
| 47 | logfiles can become quite large and that it might take a while until
|
|---|
| 48 | processing is complete.
|
|---|
| 49 |
|
|---|
| 50 | 3. INSTALLATION
|
|---|
| 51 |
|
|---|
| 52 | As OdinBug.EXE is written in VX-REXX it needs the VROBJ.DLL runtime.
|
|---|
| 53 |
|
|---|
| 54 | VROBJ.DLL can be found in the directory x:\IMAGES (x=CD-ROM drive) of
|
|---|
| 55 | your original Warp 4 CD-ROM and has to be copied into into d:\OS2\DLL
|
|---|
| 56 | (d=bootdrive), or somewhere else in your LIBPATH.
|
|---|
| 57 |
|
|---|
| 58 | There is also a VROBJ.WPI package at the following location:
|
|---|
| 59 |
|
|---|
| 60 | http://groups.yahoo.com/group/odinusers/files/vrobj.wpi
|
|---|
| 61 | ftp://ftp.os2.org/odin/weekly/vrobj.wpi
|
|---|
| 62 |
|
|---|
| 63 | This package can be installed the usual way using WarpIN.
|
|---|
| 64 |
|
|---|
| 65 | Put OdinBug.EXE in a directory within your path. The preferred place is
|
|---|
| 66 | your Odin "Windows" directory.
|
|---|
| 67 |
|
|---|
| 68 | When Odin is executed for the first time, it creates an object for itself
|
|---|
| 69 | in the Odin folder and assoiciates odin32_?.log files with it. Now you can
|
|---|
| 70 | doubleclick on any odin32_?.log file and OdinBug is fired up. You only need
|
|---|
| 71 | to specify the build file if OdinBug was launched this way.
|
|---|
| 72 |
|
|---|
| 73 | 4. CREATING A BUG REPORT
|
|---|
| 74 |
|
|---|
| 75 | Ideally OdinBug should be called immediately after you experienced a crash
|
|---|
| 76 | in a Win32 program and after you have created a log file.
|
|---|
| 77 |
|
|---|
| 78 | Step 1:
|
|---|
| 79 |
|
|---|
| 80 | OdinBug prompts you to enter the currently installed Odin-build file (i.e
|
|---|
| 81 | odin32bin-200?????.ZIP or odin32bin-200?????.WPI) in a standard OS/2 file
|
|---|
| 82 | open dialogue.
|
|---|
| 83 |
|
|---|
| 84 | Step 2:
|
|---|
| 85 |
|
|---|
| 86 | OdinBug prompts you to enter the logfile (odin32_?.log) that was created
|
|---|
| 87 | during the execution of the Win32 program.
|
|---|
| 88 |
|
|---|
| 89 | Note: If OdinBug was installed properly, you may doubleclick on a odin32_?.log
|
|---|
| 90 | file and OdinBug will be fired up. You only have to specify the buildfile, if
|
|---|
| 91 | OdinBug was launched this way.
|
|---|
| 92 |
|
|---|
| 93 | Step 3:
|
|---|
| 94 |
|
|---|
| 95 | Application page:
|
|---|
| 96 |
|
|---|
| 97 | Complete name, version and eventually a location, where the program can be
|
|---|
| 98 | downloaded. Then enter your own verbal description of the problem.
|
|---|
| 99 |
|
|---|
| 100 | All other fields on the other pages of the notebook have probably been
|
|---|
| 101 | filled automatically. Complete any missing information.
|
|---|
| 102 |
|
|---|
| 103 | Step 4:
|
|---|
| 104 |
|
|---|
| 105 | When everything is complete press "Create report" button. The program
|
|---|
| 106 | continuosly checks for empty fields, and will only let you create a
|
|---|
| 107 | report if everything is filled out.
|
|---|
| 108 |
|
|---|
| 109 | Pressing "Send eMail" starts Netscape Messenger (or any other email
|
|---|
| 110 | program; see page settings) with the appropriate email address and copies
|
|---|
| 111 | the newly created report into the clipboard, so it can be pasted into
|
|---|
| 112 | the email.
|
|---|
| 113 |
|
|---|
| 114 | Pressing "Open report" opens the newly created OdinBug.RPT with your
|
|---|
| 115 | favorite editor or viewer.
|
|---|
| 116 |
|
|---|
| 117 | 5. BUG REPORTS AND FEATURE REQUESTS FOR THIS PROGRAM (OdinBug)
|
|---|
| 118 |
|
|---|
| 119 | Just email me and tell me what you think or what you want!
|
|---|
| 120 | I will try to implement or fix it.
|
|---|
| 121 |
|
|---|
| 122 |
|
|---|
| 123 | 6. AUTHOR:
|
|---|
| 124 |
|
|---|
| 125 | Herwig Bauernfeind, 24.08.2001
|
|---|
| 126 | EMail: herwig.bauernfeind@aon.at
|
|---|
