blob: fc5653e3669a1e4c99db39805377a950ad9c8378 [file] [log] [blame]
Robert Ly35f2fda2013-01-29 16:27:05 -08001page.title=Report Bugs
2@jd:body
3
4<!--
Bert McMeen9cb839d2015-04-20 14:10:47 -07005 Copyright 2015 The Android Open Source Project
Robert Ly35f2fda2013-01-29 16:27:05 -08006
7 Licensed under the Apache License, Version 2.0 (the "License");
8 you may not use this file except in compliance with the License.
9 You may obtain a copy of the License at
10
11 http://www.apache.org/licenses/LICENSE-2.0
12
13 Unless required by applicable law or agreed to in writing, software
14 distributed under the License is distributed on an "AS IS" BASIS,
15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 See the License for the specific language governing permissions and
17 limitations under the License.
18-->
19<div id="qv-wrapper">
20 <div id="qv">
21 <h2>In this document</h2>
22 <ol id="auto-toc">
23 </ol>
24 </div>
25</div>
Bert McMeen9cb839d2015-04-20 14:10:47 -070026
27<p>Thank you for your interest in Android! One of the best ways you can help us
Robert Ly35f2fda2013-01-29 16:27:05 -080028improve Android is to let us know about any problems you find with it.</p>
Bert McMeen9cb839d2015-04-20 14:10:47 -070029<h2 id="report-issues">Report Issues</h2>
30<p class="note"><strong>Note:</strong> For security vulnerabilities, please see
31<a href="{@docRoot}devices/tech/security/overview/updates-resources.html#reporting-security-issues">Reporting Security Issues</a>. If you think you've found
32a security vulnerability, <em>please don't use the forms below</em>. Using a public form may
Robert Ly35f2fda2013-01-29 16:27:05 -080033allow anyone to see your report, which may put users at risk until the bug is
Bert McMeen9cb839d2015-04-20 14:10:47 -070034fixed. Instead, please send an email detailing the issue to security@android.com.</p>
35<p>Here's how to report <strong>non-security</strong> bugs:</p>
Robert Ly35f2fda2013-01-29 16:27:05 -080036<ul>
Bert McMeen9cb839d2015-04-20 14:10:47 -070037<li>
Jean-Baptiste Queru05437cd2013-06-18 15:46:06 -070038<p><a href="https://code.google.com/p/android/issues/advsearch">Search for
39your bug</a> to see if anyone has already reported it. Don't forget to
40search for all issues, not just open ones, as your issue might already
Bert McMeen9cb839d2015-04-20 14:10:47 -070041have been reported and closed. To help you find the most popular results,
Jean-Baptiste Queru05437cd2013-06-18 15:46:06 -070042sort the result by number of stars.</p>
Robert Ly35f2fda2013-01-29 16:27:05 -080043</li>
44<li>
45<p>If you find your issue and it's important to you, star it! That's how we know which bugs are most important to fix.</p>
46</li>
47<li>
Bert McMeen9cb839d2015-04-20 14:10:47 -070048<p>If no one has reported your bug, file the bug. You can use one of these templates:</p>
Robert Ly35f2fda2013-01-29 16:27:05 -080049<ul>
50<li>
Bert McMeen9cb839d2015-04-20 14:10:47 -070051<p><a href="https://code.google.com/p/android/issues/entry?template=User%20bug%20report">Bug in your Device</a> -
52use this if you are a user reporting a bug in a device you own</p>
Robert Ly35f2fda2013-01-29 16:27:05 -080053</li>
54<li>
Bert McMeen9cb839d2015-04-20 14:10:47 -070055<p><a href="https://code.google.com/p/android/issues/entry?template=Developer%20bug%20report">Bug in the Software</a> -
56use this if you found a bug in the course of developing an app</p>
Robert Ly35f2fda2013-01-29 16:27:05 -080057</li>
58<li>
Bert McMeen9cb839d2015-04-20 14:10:47 -070059<p><a href="https://code.google.com/p/android/issues/entry?template=Feature%20request">Feature Request</a> -
60use this for a feature you'd like to see in a future verison</p>
Robert Ly35f2fda2013-01-29 16:27:05 -080061</li>
62</ul>
63</li>
64</ul>
Jean-Baptiste Queru05437cd2013-06-18 15:46:06 -070065<p>Keep in mind that an issue tracker is not a user support forum. It is a list
66of pending technical tasks, along with information relevant for those tasks,
67and information about progress on those tasks including which ones might
68get worked on in the short term.</p>
69<p>This issue tracker is narrowly focused on the Android Open Source Project.
70Issues with retail devices need to be reported through those devices' support
71channels, especially for devices other than Nexus. Issues with applications
72that aren't part of AOSP need to be reported with those applications'
73developers; that is also the case for Google applications.</p>
Robert Ly35f2fda2013-01-29 16:27:05 -080074<p>Please note that we can't guarantee that any particular bug can be fixed in
75any particular release. To see what happens to your bug once you report it,
76read <a href="life-of-a-bug.html">Life of a Bug</a>.</p>
77<p>In general, please put as much info in bugs as you can. Just a one liner
78telling us something isn't working is usually useless, and will probably be
79closed without any action. The more detail you provide, the more likely your
80issue is to be resolved. Below, there are some examples of a good bug report
81and a poor bug report.</p>
82
83<h2 id="a-poor-bug-report">A Poor Bug Report</h2>
Clay Murphy291670d2014-09-09 16:26:00 -070084<blockquote>
Robert Ly35f2fda2013-01-29 16:27:05 -080085Title: Error message
86
87When running Eclipse I get an "Internal Error" that says "See the .log file for more details".
88
89Steps to reproduce:
90Happens when "Object o = null". Doesn't happen when changed to "Object o".
91
92Expected results:
93I wouldn't get the error message--would work with Object o = null.
94
95Observed results:
96See above.
Clay Murphy291670d2014-09-09 16:26:00 -070097</blockquote>
Robert Ly35f2fda2013-01-29 16:27:05 -080098<p>This is a poor bug report because it doesn't provide any context for the
Clay Murphye4edda62014-10-16 19:00:15 -070099issue; is it a problem in the ART runtime, the core framework, or
Robert Ly35f2fda2013-01-29 16:27:05 -0800100something else? It also doesn't provide any code or hint on how to reproduce
101it. In other words, this bug report doesn't provide enough information for
102anyone to take action on, so it would be ignored.</p>
103<h2 id="a-good-bug-report">A Good Bug Report</h2>
Clay Murphy291670d2014-09-09 16:26:00 -0700104<blockquote>
Robert Ly35f2fda2013-01-29 16:27:05 -0800105Title: Stepping over "Object o = null" causes Eclipse "Internal Error"
106
107Interesting bug, while using Eclipse 3.3.1.1 with m37a of android and the following code:
Clay Murphy291670d2014-09-09 16:26:00 -0700108<pre>
Robert Ly35f2fda2013-01-29 16:27:05 -0800109package com.saville.android;
110
111import android.app.Activity;
112import android.os.Bundle;
113import android.util.Log;
114
115public class TestObjectNull extends Activity {
116 /** Called when the activity is first created. */
117 &#64;Override
118 public void onCreate(Bundle icicle) {
119 super.onCreate(icicle);
120 setContentView(R.layout.main);
121
122 Object o = null;
123
124 o = "hi";
125
126 Log.v(TAG, "o=" + o);
127 }
128
129 static final String TAG = "TestObjectNull";
130}
Clay Murphy291670d2014-09-09 16:26:00 -0700131</pre>
Robert Ly35f2fda2013-01-29 16:27:05 -0800132Eclipse indicates an "Internal Error" with "See the .log file for more
133details" and then asks if I want to exit the workbench. This occurs when I
134place a break point on "setContentView(R.layout.main);" and then single
135step over "Object o = null;"
136
137If I change "Object o = null;" to "Object o" all is well.
138
139The last lines of the .log file are:
Clay Murphy291670d2014-09-09 16:26:00 -0700140<pre>
Robert Ly35f2fda2013-01-29 16:27:05 -0800141!ENTRY org.eclipse.core.jobs 4 2 2008-01-01 13:04:15.825
142!MESSAGE An internal error occurred during: "has children update".
143!STACK 0
144java.lang.InternalError: Invalid signature: "&lt;null&gt;"
145 at
146org.eclipse.jdi.internal.TypeImpl.signatureToTag(TypeImpl.java:307)
147 at
148org.eclipse.jdi.internal.LocalVariableImpl.tag(LocalVariableImpl.java:185)
149 at
150org.eclipse.jdi.internal.StackFrameImpl.getValues(StackFrameImpl.java:128)
151 at
152org.eclipse.jdi.internal.StackFrameImpl.getValue(StackFrameImpl.java:73)
153 at
154org.eclipse.jdt.internal.debug.core.model.JDILocalVariable.retrieveValue(JDILocalVariable.java:57)
155 at
156org.eclipse.jdt.internal.debug.core.model.JDIVariable.getCurrentValue(JDIVariable.java:66)
157 at
158org.eclipse.jdt.internal.debug.core.model.JDIVariable.getValue(JDIVariable.java:88)
159 at
160org.eclipse.debug.internal.ui.model.elements.VariableContentProvider.hasChildren(VariableContentProvider.java:62)
161 at
162org.eclipse.jdt.internal.debug.ui.variables.JavaVariableContentProvider.hasChildren(JavaVariableContentProvider.java:73)
163 at
164org.eclipse.debug.internal.ui.model.elements.ElementContentProvider.updateHasChildren(ElementContentProvider.java:223)
165 at
166org.eclipse.debug.internal.ui.model.elements.ElementContentProvider$3.run(ElementContentProvider.java:200)
167 at org.eclipse.core.internal.jobs.Worker.run(Worker.java:55)
Jean-Baptiste Queru05437cd2013-06-18 15:46:06 -0700168</pre>
Clay Murphy291670d2014-09-09 16:26:00 -0700169</blockquote>