Changeset 7741 for trunk/doc


Ignore:
Timestamp:
Jan 8, 2002, 10:38:00 AM (24 years ago)
Author:
sandervl
Message:

HB: doc update

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/ReportingBugs.txt

    r5765 r7741  
    1 /* $Id: ReportingBugs.txt,v 1.8 2001-05-20 08:23:11 sandervl Exp $ */
     1This file is a subset of the OdinBug online help file.
    22
    3 Reporting Odin bugs
    4 -------------------
    53
    6 To make our job easier when dealing with reports of failures to run
    7 certain apps, there's a standard form to report bug. (see below)
     4Reporting Bugs:
     5===============
     6
     7To make our job easier when dealing with reports of failures to run certain
     8applications, there's a standard form to report bugs.
     9Use OdinBug to create these bug reports.
    810
    911Some remarks:
    10         - always try the debug build with the application unless only
    11           only the release build shows the problem.
    12         - make sure you have installed Odin properly (WarpIN)
    13         - pe.exe is the recommended way to run windows applications; remove
    14           win32k from your config.sys (note that WarpIN does *not* install win32k)
    15         - use a recent daily build. Bug reports with ancient (> 1 week old) builds
    16           are not very useful. the problem you report might no longer be present
    17         - always send these bug reports to the odinusers mailinglist; not directly
    18           to the developers.
    19           (so others can respond if the problem is old or already fixed)
    20           (odinusers@yahoogroups.com; go to www.yahoogroups.com to subscribe)
    2112
    22 Sometimes the small part of the logfile isn't enough for us to determine
    23 where the problem lies.
    24 In that case, we'll ask you to mail us the entire file. (zipped)
    25 So please *do not* send big logfiles to the mailinglist!
     13- Always try the debug build with the application unless only the release
     14  build shows the problem.
     15- Make sure you have installed Odin properly (using WarpIN). If you installed
     16  using a ZIP file, do not forget to run OdinInst.EXE after unpacking the ZIP
     17  file!
     18- PE.EXE is the recommended way to run Windows applications; remove Win32K.SYS
     19  from your CONFIG.SYS
     20- Use a recent daily build. Bug reports with ancient (> 1 week old) builds are
     21  not very useful. The problem you report might no longer be present!
     22- Always send these bug reports to the odinusers mailing list; not directly to
     23  the developers (so others can respond if the problem is old or already
     24  fixed).
     25- Currently the only valid mailing list address is odinusers@yahoogroups.com.
     26  In order to send a bug report you have to be subscribed to this mailing
     27  list.
     28- Go to http://groups.yahoo.com/groups/odinusers/join in order to subscribe
     29  (or use the URL object that OdinBug has created in your Odin folder.)
    2630
    27 Generating useful logfiles
    28 --------------------------
    29 To enable logging in the debug build, add the following environment variable:
    30         SET WIN32LOG_ENABLED=1
     31Sometimes the small part of the logfile isn't enough for us to determine where
     32the problem lies.
    3133
    32 This turns on logging for all debug dlls.
    33 However, this can result in huge logfiles. To reduce the size, use release
    34 builds of dlls that are not relevant to the problem you're seeing.
    35 The general rule is that usually only the logging information generated by
    36 gdi32, kernel32 and user32 is important.
    37 Use the release build of gdi32 if the problem you're seeing isn't related
    38 to painting. (gdi32 generates a *lot* of logging information)
    39 
    40 Logging.txt contains information on how to selectively enable/disable logging.
    41 Doing this requires some knowledge about the layout of the Odin source tree
    42 and what each source file does.
     34In that case, we'll ask you to mail us the entire file (ZIPped).
     35So please do not send big logfiles to the mailing list!
    4336
    4437
    45 Useful tips
    46 -----------
    47 Crashes are always easy to locate in logfiles (search for 'Exception Information'),
    48 but improper behaviour isn't.
     38Generating useful logfiles:
     39===========================
     40
     41Only those builds, that have "debug" in their name can generate logfiles in
     42order to show what a win32 application is doing, while it is running. The
     43logfile is inevitable to determine why certain applications don't run
     44correctly.
     45
     46The logfile is the main source of bug information for OdinBug.
     47
     48The name of the logfile follows a naming scheme:
     49
     50         odin32_?.log, where ? is 0, 1, 2 etc.
     51
     52The major disadvantage of logging is the overhead. Therefore it has been
     53disabled by default in all the "debug" builds.
     54
     55You only get logfiles if you use a debug build and have
     56
     57         SET WIN32LOG_ENABLED=1
     58
     59properly set. This turns on logging for all debug dlls.
     60
     61However, this can result in huge logfiles. To reduce the size, use release
     62builds of dlls that are not relevant to the problem you're seeing. The general
     63rule is that usually only the logging information generated by GDI32, KERNEL32
     64and USER32 is important.
     65
     66Use the release build of GDI32 if the problem you're seeing isn't related to
     67painting. (GDI32 generates a lot of logging information)
     68
     69To disable logging again, you must clear this variable:
     70
     71         SET WIN32LOG_ENABLED=
     72
     73
     74Useful tips:
     75============
     76
     77Crashes are always easy to locate in logfiles (search for 'Exception
     78Information'), but improper behaviour isn't.
     79
    4980In the system menu (top left button of a window), there's a menu item called
    50 'Put mark in debug log'. Selecting this item puts the line 'Mark requested
    51 by user' in the log.
     81'Put mark in debug log'. Selecting this item puts the line 'Mark requested by
     82user' in the log.
     83
    5284This can be useful e.g. if a window is resized improperly after you click
    5385on a button. To make it easy for us to locate the right log lines, you
    … …  
    5688
    5789
    58 ------------ODIN BUGREPORT------------------
    59 Odin build:             date & debug/release
    60 Installed Odin:         manually/WarpIN
    61 Method of launching
    62 win32 apps:             win32k/pe.exe
    63                         (if pe.exe is used, win32k must not be loaded at all)
    64 OS/2 version:           OS/2 Warp 4 or OS/2 Warp Server for e-Business
    65                         (Warp 3 not officially supported)
    66 Fixpack level:         
    67 Display driver + ver.:  (eg. sdd/gradd/matrox etc)
     90Standard form of a bug report:
     91==============================
    6892
    69 xf86sup.sys loaded:     yes/no
     93--------------------- Begin of Odin Bug Report ----------------------
     94 
     95Odin build information:
     96 
     97  Current Odin build:     (odin32bin-2001????-debug.wpi or .zip)
     98  Installation method:    (WarpIN or manually)
     99  Launching method:       (Win32K.SYS or PE.EXE)
     100  Last WarpIN install:    (date/time)
     101  Last OdinInst install:  (date/time)
     102  Odin "Windows" dir:     (search for "Windows  dir" in logfile!)
     103  Odin "System32" dir:    (search for "System32 dir" in logfile!)
     104  Evaluated Odin.INI:     (located in System32 directory)
     105 
     106General system information:
     107 
     108  OS/2 version:           (Warp 4, 4.5, Warp 3 not officially supported)
     109  OS/2 reports version:   (2.4, 2.45) kernel revision: (14.0xx)
     110  FixPack Level:          (15)
     111  Is xf86sup.sys loaded?  Yes/No
     112  Display driver:         (Scitech/Matrox/gradd)
     113  Video Chipset:          (Matrox/Nvidia TNT/Geforec/ATI Rage Pro)
     114 
     115Win32 program information:
     116 
     117  Odin logfile:           (odin32_?.log found in the application's dir)
     118  Windows executable:     (commandline of the program)
     119  Application name:       (name)
     120  Application version:    (version)
     121  Available from:         (URL if available)
     122 
     123Verbal problem description:
    70124
    71 Windows  dir:           (search for 'Windows  dir' in odin32_0.log)
    72 System32 dir:           (search for 'System32 dir' in odin32_0.log)
     125(what happened, in your own words, be as accurate as possible)
    73126
    74 Windows application:    name, version + url (if it can be downloaded somewhere)
    75 Problem description:    Try to give an accurate desription so we can reproduce it on our systems
     127Exception information and stack dump:
    76128
    77 Log file:               Search for 'stack dump' or 'Exception Information' in odin32_0.log and include
    78                         the exception information + last few lines preceding it.
    79                         i.e:
    80                         t1: GDI32: SaveDC
    81                         t1: GDI32: StretchDIBits 1000245 to (0,0) (740,61) from (0,0) (740,61), 1d3001c 18817f0 0 cc0020
    82                         t1: ---[Exception Information]------------
    83                         t1:    Access Violation (hardware generated,portable,fatal)
    84                         t1:    Read Access at address 01d2fe4dh
    85                         t1:    Exception Address = 1d195cdc
    86                         t1: <PMWINX> (#6197), obj #0:00065cdc
    87                         t1:    Thread:  Ordinal TID: 191, TID: 1, Priority: 0200h
    88                         t1:    Process: PID: 135, Parent: 38, Status: 16
    89                         t1:    SS:ESP=0053:00130cb0 EFLAGS=00012216
    90                                CS:EIP=005b:1d195cdc EBP   =000002e4
    91                         t1:    EAX=fffffb4d EBX=0000b900 ESI=01d2fe4d
    92                                ECX=000000b9 EDX=000002e4 EDI=01d4b61c
    93                         t1:    DS=0053     ES=00000053       FS=150b     GS=0000
    94                         t1: ---[End Of Exception Information]-----
     129(search for "[Exception" in the logfile!)
    95130
    96 ------------ODIN BUGREPORT------------------
     131ODIN.INI information:
    97132
    98 
    99 
     133(located in x:\Odin\System32 directory)
     134---------------------- End of Odin Bug Report -----------------------
Note: See TracChangeset for help on using the changeset viewer.