1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>LLVM Bug Life Cycle — LLVM 13 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/llvm-theme.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="LLVM Coding Standards" href="CodingStandards.html" />
<link rel="prev" title="How to submit an LLVM bug report" href="HowToSubmitABug.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head><body>
<div class="logo">
<a href="index.html">
<img src="_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="CodingStandards.html" title="LLVM Coding Standards"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="HowToSubmitABug.html" title="How to submit an LLVM bug report"
accesskey="P">previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="GettingInvolved.html" accesskey="U">Getting Involved</a> »</li>
<li class="nav-item nav-item-this"><a href="">LLVM Bug Life Cycle</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Documentation</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>
<h3>Getting Involved</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/Contributing.html">Contributing to LLVM</a></li>
<li><a href="https://llvm.org/docs/HowToSubmitABug.html">Submitting Bug Reports</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#mailing-lists">Mailing Lists</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#irc">IRC</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#meetups-and-social-events">Meetups and Social Events</a></li>
</ul>
<h3>Additional Links</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
<li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
<li><a href="https://llvm.org/pubs">Publications</a></li>
<li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/BugLifeCycle.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="llvm-bug-life-cycle">
<h1>LLVM Bug Life Cycle<a class="headerlink" href="#llvm-bug-life-cycle" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#introduction-achieving-consistency-in-how-we-deal-with-bug-reports" id="id2">Introduction - Achieving consistency in how we deal with bug reports</a></p></li>
<li><p><a class="reference internal" href="#reporting-bugs" id="id3">Reporting bugs</a></p></li>
<li><p><a class="reference internal" href="#triaging-bugs" id="id4">Triaging bugs</a></p></li>
<li><p><a class="reference internal" href="#actively-working-on-fixing-bugs" id="id5">Actively working on fixing bugs</a></p></li>
<li><p><a class="reference internal" href="#resolving-closing-bugs" id="id6">Resolving/Closing bugs</a></p></li>
<li><p><a class="reference internal" href="#maintenance-of-products-components-metadata" id="id7">Maintenance of products/components metadata</a></p></li>
<li><p><a class="reference internal" href="#maintenance-of-cc-by-default-settings" id="id8">Maintenance of cc-by-default settings</a></p></li>
</ul>
</div>
<div class="section" id="introduction-achieving-consistency-in-how-we-deal-with-bug-reports">
<h2><a class="toc-backref" href="#id2">Introduction - Achieving consistency in how we deal with bug reports</a><a class="headerlink" href="#introduction-achieving-consistency-in-how-we-deal-with-bug-reports" title="Permalink to this headline">¶</a></h2>
<p>We aim to achieve a basic level of consistency in how reported bugs evolve from
being reported, to being worked on, and finally getting closed out. The
consistency helps reporters, developers and others to gain a better
understanding of what a particular bug state actually means and what to expect
might happen next.</p>
<p>At the same time, we aim to not over-specify the life cycle of bugs in the
<a class="reference external" href="https://bugs.llvm.org/enter_bug.cgi">the LLVM Bug Tracking System</a>, as the
overall goal is to make it easier to work with and understand the bug reports.</p>
<p>The main parts of the life cycle documented here are:</p>
<ol class="arabic simple">
<li><p><a class="reference internal" href="#reporting">Reporting</a></p></li>
<li><p><a class="reference internal" href="#triaging">Triaging</a></p></li>
<li><p><a class="reference internal" href="#actively-working-on-fixing">Actively working on fixing</a></p></li>
<li><p><a class="reference internal" href="#closing">Closing</a></p></li>
</ol>
<p>Furthermore, some of the metadata in the bug tracker, such as who to notify on
newly reported bugs or what the breakdown into products & components is we use,
needs to be maintained. See the following for details:</p>
<ol class="arabic simple">
<li><p><a class="reference internal" href="#maintenance-of-bug-products-component-metadata">Maintenance of Bug products/component metadata</a></p></li>
<li><p><a class="reference internal" href="#maintenance-of-cc-by-default-settings">Maintenance of cc-by-default settings</a></p></li>
</ol>
</div>
<div class="section" id="reporting-bugs">
<span id="reporting"></span><h2><a class="toc-backref" href="#id3">Reporting bugs</a><a class="headerlink" href="#reporting-bugs" title="Permalink to this headline">¶</a></h2>
<p>See <a class="reference internal" href="HowToSubmitABug.html"><span class="doc">How to submit an LLVM bug report</span></a> on further details on how to submit good bug reports.</p>
<p>Make sure that you have one or more people on cc on the bug report that you
think will react to it. We aim to automatically add specific people on cc for
most products/components, but may not always succeed in doing so.</p>
<p>If you know the area of LLVM code the root cause of the bug is in, good
candidates to add as cc may be the same people you’d ask for a code review in
that area. See <a class="reference internal" href="Phabricator.html#finding-potential-reviewers"><span class="std std-ref">Finding potential reviewers</span></a> for more details.</p>
</div>
<div class="section" id="triaging-bugs">
<span id="triaging"></span><h2><a class="toc-backref" href="#id4">Triaging bugs</a><a class="headerlink" href="#triaging-bugs" title="Permalink to this headline">¶</a></h2>
<p>Bugs with status NEW indicate that they still need to be triaged.
When triage is complete, the status of the bug is moved to CONFIRMED.</p>
<p>The goal of triaging a bug is to make sure a newly reported bug ends up in a
good, actionable, state. Try to answer the following questions while triaging.</p>
<ul class="simple">
<li><p>Is the reported behavior actually wrong?</p>
<ul>
<li><p>E.g. does a miscompile example depend on undefined behavior?</p></li>
</ul>
</li>
<li><p>Can you easily reproduce the bug?</p>
<ul>
<li><p>If not, are there reasonable excuses why it cannot easily be reproduced?</p></li>
</ul>
</li>
<li><p>Is it related to an already reported bug?</p>
<ul>
<li><p>Use the “See also”/”depends on”/”blocks” fields if so.</p></li>
<li><p>Close it as a duplicate if so, pointing to the issue it duplicates.</p></li>
</ul>
</li>
<li><p>Are the following fields filled in correctly?</p>
<ul>
<li><p>Product</p></li>
<li><p>Component</p></li>
<li><p>Title</p></li>
</ul>
</li>
<li><p>CC others not already cc’ed that you happen to know would be good to pull in.</p></li>
<li><p>Add the “beginner” keyword if you think this would be a good bug to be fixed
by someone new to LLVM.</p></li>
</ul>
</div>
<div class="section" id="actively-working-on-fixing-bugs">
<span id="actively-working-on-fixing"></span><h2><a class="toc-backref" href="#id5">Actively working on fixing bugs</a><a class="headerlink" href="#actively-working-on-fixing-bugs" title="Permalink to this headline">¶</a></h2>
<p>Please remember to assign the bug to yourself if you’re actively working on
fixing it and to unassign it when you’re no longer actively working on it. You
unassign a bug by setting the Assignee field to “<a class="reference external" href="mailto:unassignedbugs%40nondot.org">unassignedbugs<span>@</span>nondot<span>.</span>org</a>”.</p>
</div>
<div class="section" id="resolving-closing-bugs">
<span id="closing"></span><h2><a class="toc-backref" href="#id6">Resolving/Closing bugs</a><a class="headerlink" href="#resolving-closing-bugs" title="Permalink to this headline">¶</a></h2>
<p>For simplicity, we only have 1 status for all resolved or closed bugs:
RESOLVED.</p>
<p>Resolving bugs is good! Make sure to properly record the reason for resolving.
Examples of reasons for resolving are:</p>
<ul class="simple">
<li><p>Revision NNNNNN fixed the bug.</p></li>
<li><p>The bug cannot be reproduced with revision NNNNNN.</p></li>
<li><p>The circumstances for the bug don’t apply anymore.</p></li>
<li><p>There is a sound reason for not fixing it (WONTFIX).</p></li>
<li><p>There is a specific and plausible reason to think that a given bug is
otherwise inapplicable or obsolete.</p>
<ul>
<li><p>One example is an old open bug that doesn’t contain enough information to
clearly understand the problem being reported (e.g. not reproducible). It is
fine to resolve such a bug e.g. with resolution WORKSFORME and leaving a
comment to encourage the reporter to reopen the bug with more information
if it’s still reproducible on their end.</p></li>
</ul>
</li>
</ul>
<p>If a bug is resolved, please fill in the revision number it was fixed in in the
“Fixed by Commit(s)” field.</p>
</div>
<div class="section" id="maintenance-of-products-components-metadata">
<span id="maintenance-of-bug-products-component-metadata"></span><h2><a class="toc-backref" href="#id7">Maintenance of products/components metadata</a><a class="headerlink" href="#maintenance-of-products-components-metadata" title="Permalink to this headline">¶</a></h2>
<p>Please raise a bug against “Bugzilla Admin”/”Products” to request any changes
to be made to the breakdown of products & components modeled in Bugzilla.</p>
</div>
<div class="section" id="maintenance-of-cc-by-default-settings">
<span id="id1"></span><h2><a class="toc-backref" href="#id8">Maintenance of cc-by-default settings</a><a class="headerlink" href="#maintenance-of-cc-by-default-settings" title="Permalink to this headline">¶</a></h2>
<p>Please raise a bug against “Bugzilla Admin”/”Products” to request any changes
to be made to the cc-by-default settings for specific components.</p>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="CodingStandards.html" title="LLVM Coding Standards"
>next</a> |</li>
<li class="right" >
<a href="HowToSubmitABug.html" title="How to submit an LLVM bug report"
>previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="GettingInvolved.html" >Getting Involved</a> »</li>
<li class="nav-item nav-item-this"><a href="">LLVM Bug Life Cycle</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2003-2021, LLVM Project.
Last updated on 2021-09-18.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
</body>
</html>
|
