Ignore:
Timestamp:
Dec 26, 2001, 7:54:42 PM (24 years ago)
Author:
sandervl
Message:

OdinBug 0.5.5 updates

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/Readme.Odinbug

    r6717 r7690  
    1 Odin Bug Report Tool Version 0.5.0
    2 ==================================
     1Odin Bug Report Generator Version 0.5.5
     2=======================================
    33
    4 0. DISCLAIMER
     40. Disclaimer
     5=============
    56
    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.
     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 sourcecode it currently available only upon request (but also for free!).
    1011
    11 1. INTRODUCTION
     121. Introduction
     13===============
    1214
    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!
     15The main goal of this program is to make creating proper bug reports for Team
     16Odin more comfortable.
    1617
    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).
     18The reason I started to write this program was, that I saw every day that
     19Sander van Leeuwen and other Team Odin members write emails, telling  us users
     20to bring in proper bug reports (I don't exclude myself).
    2021
    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.
     22Well, I would like Sander and all the others to spend there time on Odin and
     23not writing emails about things that should be a non-issue.
    2324
    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
     252. Installation
     26===============
    5127
    5228As OdinBug.EXE is written in VX-REXX it needs the VROBJ.DLL runtime.
    5329
    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
     30VROBJ.DLL can be found in the directory x:\IMAGES (x=CD-ROM drive) of  your
     31original Warp 4 CD-ROM and has to be copied into into d:\OS2\DLL
    5632(d=bootdrive), or somewhere else in your LIBPATH.
    5733
    … …  
    6339This package can be installed the usual way using WarpIN.
    6440
    65 Put OdinBug.EXE in a directory within your path. The preferred place is
    66 your Odin "Windows" directory.
     41Put OdinBug.EXE into your Odin "Windows" directory.
    6742
    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.
     43Whenever a new version of OdinBug is executed for the first time, it  creates
     44an object for itself (and a few others) in the Odin folder and  associates
     45odin32_?.log files with it. Now you can doubleclick on any  odin32_?.log file
     46and OdinBug is fired up.
    7247
    73 4. CREATING A BUG REPORT
     48Note: XWorkplace users should create "Odin Log Files" as a subtype of  "Plain
     49Text" and associate OdinBug with that filetype in order to have  OdinBug as a
     50default for Odin logfiles and your favorites text editor  as additional
     51editor/viewer.
    7452
    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.
     53Before pressing "Create" for the first time you have to configure your  email
     54client on the "EMail" page.
    7755
    78 Step 1:
     563. WHAT IT DOES
    7957
    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.
     58OdinBug presents a notebook of forms to fill in the information  needed
     59by Team Odin and generates a report that follows the standards  defined by
     60Team Odin (see Online help for details).
    8361
    84 Step 2:
     62Generally this program needs 1 file as input from the user:
    8563
    86 OdinBug prompts you to enter the logfile (odin32_?.log) that was created
    87 during the execution of the Win32 program.
     64- the Odin log file:   odin32_?.log
    8865
    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.
     66Note: Only debug builds can create log files!!!
    9267
    93 Step 3:
     68It will try to determine the Odin buildfile automatically, but if this  fails
     69or OdinBug is unsure, it will prompt the user to enter a valid  buildfile,
     70too.
    9471
    95 Application page:
     72As soon as the user has specified these files, all the other information  is
     73gathered from CONFIG.SYS, SYSLEVEL files, the WarpIN database, from  ODIN.INI
     74and also from the odin32_?.log files. Only minor adjustments  should have to
     75be made (especially from users with non-Scitech Display  drivers).
    9676
    97 Complete name, version and eventually a location, where the program can be
    98 downloaded. Then enter your own verbal description of the problem.
     77It also scans the odin_?.log file to find the exception information  and the
     78stack dump in case an application traps. Be aware that these  logfiles can
     79become quite large and that it might take a while until  processing is
     80complete.
    9981
    100 All other fields on the other pages of the notebook have probably been
    101 filled automatically. Complete any missing information.
     82The exception is presented on the exceptions page of OdinBug.
    10283
    103 Step 4:
     844. USAGE
    10485
    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.
     86OdinBug is quite self explanatory anyway and there is a full featured
     87online help and manual available. Please, read it!
    11688
    117895. BUG REPORTS AND FEATURE REQUESTS FOR THIS PROGRAM (OdinBug)
    11890
    119 Just email me and tell me what you think or what you want!
    120 I will try to implement or fix it.
     91Just email *me* and tell me what you think or what you would like to see!  I
     92will try to implement or fix it.
    12193
    12294
    123956. AUTHOR:
    12496
    125 Herwig Bauernfeind, 24.08.2001
    126 EMail: herwig.bauernfeind@aon.at
     97Herwig Bauernfeind, 24-11-2001 EMail: herwig.bauernfeind@aon.at
Note: See TracChangeset for help on using the changeset viewer.