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

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