home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / odin051d.zip / Readme.Odinbug < prev    next >
Text File  |  2001-12-26  |  4KB  |  98 lines
  1. Odin Bug Report Generator Version 0.5.5
  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 sourcecode it currently available only upon request (but also for free!).
  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. Put OdinBug.EXE into your Odin "Windows" directory.
  42.  
  43. Whenever a new version of OdinBug is executed for the first time, it  creates
  44. an object for itself (and a few others) in the Odin folder and  associates
  45. odin32_?.log files with it. Now you can doubleclick on any  odin32_?.log file
  46. and OdinBug is fired up. 
  47.  
  48. Note: XWorkplace users should create "Odin Log Files" as a subtype of  "Plain
  49. Text" and associate OdinBug with that filetype in order to have  OdinBug as a
  50. default for Odin logfiles and your favorites text editor  as additional
  51. editor/viewer.
  52.  
  53. Before pressing "Create" for the first time you have to configure your  email
  54. client on the "EMail" page.
  55.  
  56. 3. WHAT IT DOES
  57.  
  58. OdinBug presents a notebook of forms to fill in the information  needed
  59. by Team Odin and generates a report that follows the standards  defined by
  60. Team Odin (see Online help for details).
  61.  
  62. Generally this program needs 1 file as input from the user:
  63.  
  64. - the Odin log file:   odin32_?.log
  65.  
  66. Note: Only debug builds can create log files!!!
  67.  
  68. It will try to determine the Odin buildfile automatically, but if this  fails
  69. or OdinBug is unsure, it will prompt the user to enter a valid  buildfile,
  70. too.
  71.  
  72. As soon as the user has specified these files, all the other information  is
  73. gathered from CONFIG.SYS, SYSLEVEL files, the WarpIN database, from  ODIN.INI
  74. and also from the odin32_?.log files. Only minor adjustments  should have to
  75. be made (especially from users with non-Scitech Display  drivers).
  76.  
  77. It also scans the odin_?.log file to find the exception information  and the
  78. stack dump in case an application traps. Be aware that these  logfiles can
  79. become quite large and that it might take a while until  processing is
  80. complete.
  81.  
  82. The exception is presented on the exceptions page of OdinBug.
  83.  
  84. 4. USAGE
  85.  
  86. OdinBug is quite self explanatory anyway and there is a full featured
  87. online help and manual available. Please, read it!
  88.  
  89. 5. BUG REPORTS AND FEATURE REQUESTS FOR THIS PROGRAM (OdinBug)
  90.  
  91. Just email *me* and tell me what you think or what you would like to see!  I
  92. will try to implement or fix it.
  93.  
  94.  
  95. 6. AUTHOR:
  96.  
  97. Herwig Bauernfeind, 24-11-2001 EMail: herwig.bauernfeind@aon.at 
  98.