Home My Page Projects Code Snippets Project Openings SML/NJ
Summary Activity Forums Tracker Lists Tasks Docs Surveys News SCM Files

SCM Repository

[smlnj] Annotation of /bugs/trunk/README.bugs
ViewVC logotype

Annotation of /bugs/trunk/README.bugs

Parent Directory Parent Directory | Revision Log Revision Log


Revision 944 - (view) (download)

1 : macqueen 944 SML/NJ bug records
2 :    
3 :     Files:
4 :     ------
5 :     README.bugs (this file)
6 :     form sample bug report form
7 :     bugs.nnnn-mmmm collected bug reports
8 :     openbugs list of bugs currently "open" (needing to be fixed)
9 :     tests.tar.Z collection of bug test cases
10 :    
11 :     The SML/NJ bug reports are split into files with at most 200 bug
12 :     reports each, so that each file will be of a manageable size. The
13 :     files are named "bugs.0001-0200", "bugs.0201-0400", etc. They contain
14 :     the cumulative record of all bugs ever recorded; most of these bugs
15 :     have been fixed.
16 :    
17 :     The bugs that are currently open are listed in the file "openbugs".
18 :    
19 :    
20 :     Format of bug reports
21 :     ---------------------
22 :     The format of bug reports is
23 :    
24 :     Number: the unique sequence number of the bug
25 :     Title: a short (one line) descriptive title
26 :     Keywords: keywords used to categorize the bug, e.g. "modules", "signals"
27 :     Submitter: name and email address of submitter
28 :     Date: date submitted
29 :     Version: SML/NJ version number; tool or library version number if relevant
30 :     System: architecture-os description, e.g. x86-linux, sparc-sunos
31 :     Severity: characterization of severity of the bug ("minor", "major", "critical")
32 :     Problem: description of the problem
33 :     Code: code that manifests the problem
34 :     Transcript: transcript that illustrates the behavior
35 :     Comments: additional comments
36 :     Fix: suggested fix, if available
37 :     Test: test case code (e.g. bug367.sml), normally found in bugs/tests
38 :     Owner: person currently responsible for fixing the bug
39 :     Status: status of the bug (open, fixed, etc.)
40 :    
41 :     The Number, Keywords, Test, Owner, and Status fields are filled in by
42 :     the bug list maintainers. The rest may be provided by the submitter
43 :     of the bug report.
44 :    
45 :     To facilitate processing, special formats should be observed for the
46 :     Date and Status fields. The formats are:
47 :    
48 :     Date: mm/dd/yy
49 :     Status: fixed in <version-number> ...
50 :     open ...
51 :     not a bug ...
52 :     same as <number> ...
53 :     not important ...
54 :     not reproducible ...
55 :     obsolete
56 :    
57 :     The file "form" contains a sample bug report format.
58 :    
59 :    
60 :     How to submit a bug report
61 :     --------------------------
62 :     New bug reports should be mailed to
63 :    
64 :     sml-bugs@research.bell-labs.com.
65 :    
66 :     Before mailing a report, please check out the existing report to see
67 :     if your problem is covered. But when in doubt, please do not hesitate
68 :     to submit a report, since even redundant reports can provide useful
69 :     information or additional test cases. Of course, the most helpful
70 :     bug reports are those accompanied by a succinct bit of code that
71 :     manifests the bug. (Actually, that's not quite right -- the most
72 :     helpful bug reports are those with the "Fix" field filled in!)
73 :    
74 :     The collection of test cases for bugs is provided in the compressed
75 :     tar file tests.tar.Z. These tests are used as part of the regression
76 :     test suite for the compiler.
77 :    
78 :     Dave MacQueen
79 :     dbm@research.bell-labs.com

root@smlnj-gforge.cs.uchicago.edu
ViewVC Help
Powered by ViewVC 1.0.0