source: trunk/doc/Readme.Odinbug@ 10366

Last change on this file since 10366 was 9650, checked in by sandervl, 23 years ago

HB: Updated to version 0.5.8

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