8
8
<!ENTITY language "en">
10
<article id="bugs" status="draft">
12
12
<title>Bug Reports</title>
16
This document will provide you with step-by-step procedures in filing bug
17
reports for the &kubuntu; project.
16
This document provides step-by-step procedures for filing &kubuntu; bug reports.
23
22
<title>Types of Bug Reports</title>
25
There are typically three types of bug reports which are
26
<emphasis>crash</emphasis>, <emphasis>non-crash</emphasis>, and
27
<emphasis>feature request</emphasis>.
24
Generally, there are three types of bug reports: <emphasis>crash</emphasis>,
25
<emphasis>non-crash</emphasis>, and <emphasis>feature request</emphasis>.
29
27
<variablelist><title>Overview of bug types</title>
30
28
<varlistentry><term>Crash</term>
33
Pertains to an application or a system crash or failure. In this case, most of
34
the time, a crash dialog will be presented in which you can turn into a bug
31
An application or system crash or failure. Most of the time, a crash dialog will
32
be presented that can be turned into a bug report.
39
36
<varlistentry><term>Non-crash</term>
42
Pertains to a bug or a regression that doesn't cause the application to crash,
43
but causes the application to not function as it should.
39
A bug or regression that doesn't cause the application to crash, but does cause
40
the application to stop functioning properly.
47
44
<varlistentry><term>Feature request</term>
50
Also known as a wish list item, this type of report is filed when you would like
51
to see a function added to an application or something changed in the
52
application that isn't a regression or a crash.
47
Also known as a wish list item, this type of report is filed to add a function
48
to an application, or to change something in the application that isn't due to a
49
regression or a crash.
63
60
<para><ulink url="https://bugs.kde.org/"/></para>
65
62
KDE uses Bugzilla, a "Defect Tracking System". Bugzilla is one of the
66
most popular tools used in the open source development community and is used by
63
most popular tools used in the open source development community.
69
65
<note><title>Register first</title>
71
Prior to reporting a bug, you must first register an account on KDE's Bugzilla
67
To report a bug, a person must be registered for an account on KDE's Bugzilla
72
68
at <ulink url="https://bugs.kde.org/createaccount.cgi"/>. A valid email address
73
69
is required for registration.
76
<note><title>File KDE only bugs here</title>
72
<note><title>Only for KDE bugs</title>
78
Only bugs related to KDE get filed here. If an application you are using is not
79
part of KDE, then you will need to file the report in Launchpad instead. Please
80
see the next section concerning Launchpad if you need to file a report there.
74
This system is only for bugs related to KDE. If the application is not part of
75
KDE, then the report should be filed in Launchpad instead. Please see the next
76
section, which covers filing reports concerning Launchpad.
88
84
Launchpad is an open source suite of tools that help people and teams to work
89
85
together on software projects. Launchpad is used by the Ubuntu and &kubuntu;
90
Project was well as various other open source projects.
86
Projects, as well as various other open source projects.
92
88
<note><title>Register first</title>
94
Prior to reporting a bug, you must first register an account on Launchpad at
90
To report a bug, a person must be registered for an account on Launchpad at
95
91
<ulink url="https://launchpad.net/+login"/>. A valid email address is required
99
<note><title>File any bug in &kubuntu; here</title>
95
<note><title>For any bug in &kubuntu;</title>
101
97
Launchpad can be used to file a bug report for any application available in the
102
Ubuntu application repositories. If the application you are filing a report
103
against is a KDE application, it is preferred that you use the KDE system for
98
Ubuntu or &kubuntu; repositories. If the report is for a KDE application, the
99
KDE Bug Tracking system (above) is preferred.
111
106
<title>Filing a Crash Report</title>
113
108
When an application crashes in &kubuntu;, the appropriate crash dialog will
114
appear usually allowing you to easily file a bug report from the dialog. If the
115
application is a KDE application, then the KDE crash dialog will appear allowing
116
you to report the bug, if it is not a KDE application, then the Ubuntu crash
117
dialog will appear, which will direct you to filing a bug on Launchpad.
109
appear. It is usually easy to file a bug report from the dialog. With a KDE
110
application, the KDE crash dialog will appear along with instructions
111
for reporting the bug. Otherwise, the Ubuntu crash dialog will appear with
112
instructions for filing a bug on Launchpad.
119
114
<sect2 id="filing-crash-kde">
120
115
<title>KDE</title>
122
When an application crashes in KDE, you will be presented with a crash dialog
123
similar to the following images. Note that the first image is showing the
124
<guilabel>General</guilabel> tab which provides a brief overview of the crash to
125
the user. The second image is showing the <guilabel>Developer
126
Information</guilabel> tab which provides a trace of the crash that is useful to
117
When an application crashes in KDE, a crash dialog will be presented that is
118
similar to the following images. The first image shows the
119
<guilabel>General</guilabel> tab which provides an overview of the crash. The
120
second image shows the <guilabel>Developer Information</guilabel> tab which
121
provides trace information that is useful to developers.
150
From the crash dialog, if the trace is deemed valuable, filing a bug report is
151
easy. If the trace is not deemed valuable, then filing a bug report via the
152
wizard will not be possible, and would have to be done manually at <ulink
153
url="https://bugs.kde.org/"/>.
144
If the trace information is deemed valuable, filing a bug report is
145
easy with the crash dialog wizard. If the trace is not deemed valuable, then it
146
is not possible to file a bug report with the wizard. The bug report can still
147
be filed manually at <ulink url="https://bugs.kde.org/"/>.
156
150
To complete the bug reporting process, follow the procedure below.
193
Select the options that are applicable to your case. The drop-down box under the
194
question, "<guilabel>Does the application crash again if you repeat the
195
same situation?</guilabel>" has the following options.
187
Select the applicable options. The drop-down box under the question,
188
"<guilabel>Does the application crash again if you repeat the
189
same situation?</guilabel>" has several options.
216
Depending on the information available in your crash report, you will be
217
presented with either one of the two following dialogs. The first is a dialog
218
letting you know there is not enough information to file a good report, and the
219
second is a dialog letting you know the information is good and you can continue
220
with the report filing.
210
Depending on the information available in the crash report, either of two
211
dialogs will appear. One is a dialog that indicates that there is not enough
212
information to file a good report. The other is a dialog indicating that the
213
information is useful, and that it would be helpful to continue with filing the
242
236
<note><title>If there was not enough information...</title>
244
You may need to install the proper debug packages in order to get a good trace.
245
Such packages include <filename>kdebase-dbg</filename>,
238
It may be necessary to install the proper debug packages in order to get a good
239
trace. Such packages include <filename>kdebase-dbg</filename>,
246
240
<filename>kdebase-workspace-dbg</filename>,
247
241
<filename>kdebase-runtime-dbg</filename>.
253
If there was enough information provided to continue filing a bug report using
254
the assistant, you will be presented with a dialog that allows you to login to
247
If enough information was provided to continue filing a bug report using
248
the assistant, a dialog will appear to allow logging in to KDE's Bugzilla.
267
260
<note><title>Use e-mail address as username</title>
269
You need to use the e-mail address in which you used to register with KDE's
262
Use the e-mail address that was used to register with KDE's Bugzilla.
276
After entering your username (e-mail address) and password to login,
268
After logging in with username (e-mail address) and password,
277
269
<mousebutton>click</mousebutton> the <guibutton>Login</guibutton> button. The
278
assistant will now check for duplicates and then you will be presented with the
270
assistant will check for duplicates and display the following dialog.
294
If you recognize a possible duplicate report, you can
295
<mousebutton>click</mousebutton> the report in the list and then
296
<mousebutton>click</mousebutton> the <guibutton>Open selected report</guibutton>
297
button. You will be presented with either of the following dialogs.
285
If there is a possible duplicate report, <mousebutton>click</mousebutton> the
286
report in the list and then <mousebutton>click</mousebutton> the <guibutton>Open
287
selected report</guibutton> button. Either of the following dialogs will be
322
If your bug is in fact a duplicate, you can <mousebutton>click</mousebutton> the
323
<guibutton>Add as a possible duplicate</guibutton> button. This will go through
324
and file the report letting the developers know it is in fact a possible
325
duplicate. You could also <mousebutton>click</mousebutton> the <guibutton>Attach
326
to this report (Advanced)</guibutton> which will attach your crash information
327
to the report. It is recommended, unless you know what you are doing here, to
328
select <guibutton>Add as a possible duplicate</guibutton>.
313
If the bug appears to be a duplicate, <mousebutton>click</mousebutton> the
314
<guibutton>Add as a possible duplicate</guibutton> button. This will file the
315
bug report and inform the developers that it may be a duplicate. This is
316
recommended, except in cases with experienced users where it is clearly not a
317
duplicate. <mousebutton>Clicking</mousebutton> the <guibutton>Attach to this
318
report (Advanced)</guibutton> will attach the crash information to the report.
331
If your bug is not a duplicate, you can simply <mousebutton>click</mousebutton>
321
If the bug is not a duplicate, simply <mousebutton>click</mousebutton>
332
322
the <guibutton>Next</guibutton> in the dialog showing the possible duplicates.
333
You will be presented with a dialog asking to <guibutton>Let me check more
334
reports</guibutton> or to prevent checking for more reports and continuing on to
335
file your report, you can <mousebutton>click</mousebutton> the <guibutton>There
336
are no real duplicates</guibutton> button. You will be presented with the
337
following dialog in which you can fill out the information concerning your
323
A dialog will appear with <guibutton>Let me check more reports</guibutton>. To
324
prevent checking for more reports and continue to file the report,
325
<mousebutton>click</mousebutton> the <guibutton>There
326
are no real duplicates</guibutton> button. A dialog will appear to enter
327
additional information concerning the report.
353
Once you have completed filling in the details of the bug report,
354
<mousebutton>click</mousebutton> the <guibutton>Next</guibutton> button. You
355
will be presented with the following dialog.
342
Once the details of the bug report are complete,
343
<mousebutton>click</mousebutton> the <guibutton>Next</guibutton> button. The
344
following dialog will be presented.
387
<emphasis role="bold">Congratulations!</emphasis> You just completed a
388
successful crash report. Thank you for helping to make &kubuntu; and KDE better.
389
You will be notified via e-mail of any updates to the bug report. This allows
390
you to follow along with the progress as well as answer any further questions
391
the developers may have for you.
375
<emphasis role="bold">Congratulations on a successful bug report!</emphasis>
376
Identifying and reporting bugs are essential to improving &kubuntu; and KDE.
377
Some emails may be sent to the registered address to update progress or to
378
allow developers to get additional information about the bug.
394
381
<sect2 id="filing-crash-lp">
395
382
<title>Launchpad</title>
397
When an application crashes in &kubuntu; that is not a KDE application, you will
398
be presented with a pop-up notification from <application>Apport</application>
399
similar to the following image.
384
When an application that is not KDE crashes in &kubuntu;, a pop-up notification
385
will appear from <application>Apport</application> that is similar to the
402
389
<example><title>Apport Crash Pop-pup Notification</title>
410
397
<note><title>Crash information may be different</title>
412
In order to create screen shots of the crash instance, I made the application
413
<application>VLC</application> crash purposely. Your dialogs that you are
414
presented may be different, and in the cases provided below, when you see the
415
application name, <application>VLC</application>, note that it will be the name
416
of the actual application that crashed for you.
399
The following screen shots were created by crashing the application
400
<application>VLC</application> deliberately. Crash dialogs associated with other
401
applications will be different. In an actual bug situation, the application
402
name, <application>VLC</application>, will be replaced by the name of the
403
application that actually crashed.
442
429
<mousebutton>Click</mousebutton> the <guibutton>Report Problem...</guibutton>
443
button. You will be presented with the following <guilabel>Collecting Problem
444
Information</guilabel> progress dialog.
430
button. The <guilabel>Collecting Problem Information</guilabel> progress dialog
447
434
<example><title>Collecting Problem Information</title>
459
After all of the information concerning the crash is collected, you will be
460
presented with a dialog that allows you to view the details of the report as
461
well as send the report to the developers. <mousebutton>Click</mousebutton> the
462
<guibutton>Details...</guibutton> button to view details of the report. You will
463
be presented with the following dialog.
446
After all of the information concerning the crash is collected, a dialog will
447
be presented that displays the details of the report, and the report is sent to
448
the developers. <mousebutton>Click</mousebutton> the
449
<guibutton>Details...</guibutton> button to view details of the report. The
450
following dialog will be presented.
466
453
<example><title>Send problem report to the developers? (Details)</title>
477
<mousebutton>Click</mousebutton> the <guibutton>Send</guibutton> button to go
478
ahead and send the report to the developers, in this case it will send the
479
report to Launchpad. You will be presented with the following progress dialog.
464
<mousebutton>Click</mousebutton> the <guibutton>Send</guibutton> button to send
465
the report to the developers. In this case, it will send the report to
466
Launchpad. The following progress dialog will be presented.
482
469
<example><title>Uploading problem information</title>
493
After the progress dialog completes, your default web browser will open to
494
Launchpad either presenting you with the login page, or the beginning stage of
495
the online version of the bug reporting process. After logging in, if necessary,
496
you will be presented with the following page.
480
After the progress dialog completes, the default web browser will open to
481
Launchpad presenting either the login page or the beginning of the online
482
version of the bug reporting process. After logging in (if necessary) the
483
following page will be presented.
499
486
<example><title>Please wait while bug data is processed...</title>
525
<mousebutton>Click</mousebutton> the <guibutton>Next</guibutton> button. You
526
will be presented with the following page.
512
<mousebutton>Click</mousebutton> the <guibutton>Next</guibutton> button. The
513
following page will be presented.
529
516
<example><title>Further information</title>
540
Fill in any extra information you can concerning the bug report such as what you
541
were doing when it crashed or the online file locations that may have caused the
542
crash. The following is just a very brief description filed with the report in
527
Any extra information can be filled in about the bug report such as what was
528
being done when it crashed or the online file locations that may have caused the
529
crash. The following is a brief description filed with the report in
572
<emphasis role="bold">Congratulations!</emphasis> You just completed a
573
successful crash report. Thank you for helping to make &kubuntu; better. You
575
be notified via e-mail of any updates to the bug report. This allows you to
576
follow along with the progress as well as answer any further questions the
577
developers may have for you.
559
<emphasis role="bold">Congratulations on making a successful crash
560
report!</emphasis>Identifying and reporting bugs are essential to improving
561
&kubuntu;. Some emails may be sent to the registered address to update progress
562
or to allow developers to get additional information about the bug.
582
567
<sect1 id="filing-non-crash">
583
568
<title>Filing a Non-Crash or Regression Report</title>
585
When you feel an application has regressed in its functionality, you should
586
consider filing a bug report on that application. A regress occurs when a
587
previous release had a function that worked, but in the latest release it is not
588
working. In many cases this type of report will be filed by those who have more
589
experience and may be testing beta quality software, however there are cases
590
where a user needs to report an issue with an application that isn't crashing,
591
and the following procedures will help.
570
If an application has regressed in its functionality, a bug report should be
571
filed on that application. A regress occurs when a function worked in a previous
572
release but in the latest release, it is not working. In most cases, this type
573
of report will be filed by those who have more experience and may be testing
574
beta quality software. However there are situations where a user needs to report
575
an issue with an application that isn't working right, but isn't crashing. The
576
following procedures will help.
593
578
<sect2 id="filing-non-crash-kde">
594
579
<title>KDE</title>
596
Filing non-crash related bug reports for KDE applications are done via your web
581
Filing non-crash related bug reports for KDE applications are done with a web
597
582
browser using <ulink url="https://bugs.kde.org/"/>.
599
584
<note><title>Register first</title>
601
Prior to filing any sort of bug report with KDE, you should register an account
602
on the bug tracker if you haven't yet. KDE's bug tracker is located at <ulink
603
url="https://bugs.kde.org/"/>.
586
To report a bug, a person must be registered for an account on the bug tracker.
587
KDE's bug tracker is located at <ulink url="https://bugs.kde.org/"/>.
606
590
<procedure><title>Filing a bug report without a crash</title>
609
In your web browser, go to <ulink url="https://bugs.kde.org/"/> and either
610
create a new account or login if you haven't already. Once logged in, you will
611
be presented with the following page.
593
In a web browser, go to <ulink url="https://bugs.kde.org/"/> and either
594
create a new account or login. Once logged in, the following page will be
614
598
<example><title>Welcome to the KDE Bug Tracking System</title>
625
609
<mousebutton>Click</mousebutton> the <guilabel>Report New Wish or Bug</guilabel>
626
610
link in the top-right-hand corner of the page to start the process of filing the
627
bug report. You will be presented with the following page.
611
bug report. The following page will be presented.
630
614
<example><title>Welcome to the KDE Bug Report Wizard!</title>
641
<mousebutton>Click</mousebutton> the <guibutton>Continue</guibutton> button. You
642
will be presented with the following page.
625
<mousebutton>Click</mousebutton> the <guibutton>Continue</guibutton> button. The
626
following page will be presented.
645
629
<example><title>Software Configuration</title>
656
640
Select the proper <guilabel>KDE Version</guilabel> (required) and the
657
641
<guilabel>Distribution Method</guilabel> (Should be <guilabel>Ubuntu
658
Packages</guilabel>) from the drop down menus. <mousebutton>Click</mousebutton>
642
Packages</guilabel>) from the drop-down menus. <mousebutton>Click</mousebutton>
659
643
the <guibutton>Continue</guibutton> button when finished with the selections.
660
You will be presented with the following page.
644
The following page will be presented.
663
647
<example><title>Application Selection</title>
674
If the application you are filing the report on is in the
675
<guilabel>Application</guilabel> list, select it and press the
676
<guibutton>Continue</guibutton> button. If the application is not in the list,
677
skip to the next step.
658
If the application being reported is in the <guilabel>Application</guilabel>
659
list, select it and press the <guibutton>Continue</guibutton> button. If the
660
application is not in the list, skip to the next step.
682
665
Under the <guilabel>Find</guilabel> section under the
683
666
<guilabel>Application</guilabel> list, fill in the <guilabel>Keyword
684
Search</guilabel> text box with the application you would like to file the
685
report on. It should look similar to the following image.
667
Search</guilabel> text box with the application being reported. It should look
668
similar to the following image.
688
671
<example><title>Application Selection (Search for application)</title>
697
If the application is located, you will be returned to a page similar to the
698
previous with the application highlighted.
680
If the application is located, a page will be displayed similar to the previous
681
one with the application highlighted.
703
<mousebutton>Click</mousebutton> the <guibutton>Continue</guibutton> button. You
704
will be presented with the following page.
686
<mousebutton>Click</mousebutton> the <guibutton>Continue</guibutton> button. The
687
following page will be presented.
707
690
<example><title>General Information</title>
718
In the <guilabel>Summary</guilabel> text box, enter the summary in an
719
informational manner. An example is provided under the text box. Select
720
<guilabel>Linux</guilabel> in the <guilabel>Operating System</guilabel> drop
721
down menu. When completed, <mousebutton>Click</mousebutton> the
722
<guibutton>Continue</guibutton> button. You will be presented with the following
701
In the <guilabel>Summary</guilabel> text box, enter the summary with
702
information similar to the example under the text box. Select
703
<guilabel>Linux</guilabel> in the <guilabel>Operating System</guilabel>
704
drop-down menu. When completed, <mousebutton>Click</mousebutton> the
705
<guibutton>Continue</guibutton> button. The following page will be presented.
726
708
<example><title>Check for Duplicate Bug Reports</title>
737
719
If a duplicate report is found, click on that report ID to view the report. If
738
it is a duplicate, then simply enter text in the large text box confirming it if
739
more information is needed. If it isn't needed, you do not need to enter
740
anything. If there are no duplicate reports found,
741
<mousebutton>Click</mousebutton> the <guibutton>Continue</guibutton> button. You
742
will be presented with the following page.
720
it is a duplicate and more information is needed, then simply enter text in the
721
large text box confirming it. If more information is not needed, nothing need
722
be entered. If no duplicate reports are found, <mousebutton>Click</mousebutton>
723
the <guibutton>Continue</guibutton> button. The following page will be
745
727
<example><title>Bug Entry Form</title>
756
The <guilabel>Severity</guilabel> (required) drop down menu should display the
738
The <guilabel>Severity</guilabel> (required) drop-down menu should display the
757
739
<guilabel>Bug - Bug report (no crashes)</guilabel> option. In the <guilabel>Long
758
Description in English</guilabel> (required) text box, enter in all information
740
Description in English</guilabel> (required) text box, enter all information
759
741
pertaining to the bug report. When completed, <mousebutton>Click</mousebutton>
760
the <guibutton>Continue</guibutton> button. You will be presented with the
742
the <guibutton>Continue</guibutton> button. The following page will be
764
746
<example><title>Bug Submitted</title>
775
<emphasis role="bold">Congratulations!</emphasis> You just completed a
776
successful non-crash related bug report. Thank you for helping to make &kubuntu;
777
and KDE better. You will be notified via e-mail of any updates to the bug
778
report. This allows you to follow along with the progress as well as answer any
779
further questions the developers may have for you.
757
<emphasis role="bold">Congratulations on making a successful non-crash related
758
bug report!</emphasis> Identifying and reporting bugs are essential to improving
759
&kubuntu; and KDE. Some emails may be sent to the registered address to update
760
progress or to allow developers to get additional information about the bug.
782
763
<sect2 id="filing-non-crash-lp">
783
764
<title>Launchpad</title>
785
766
Filing non-crash related bug reports in non-KDE applications can be done either
786
by going to <ulink url="https://bugs.launchpad.net/ubuntu/+filebug"/> in your
787
web browser or by using the <application>Apport</application> bug reporting
788
application. The following procedure will display the use of
767
by going to <ulink url="https://bugs.launchpad.net/ubuntu/+filebug"/> in a web
768
browser or by using the <application>Apport</application> bug reporting
769
application. The following procedure will demonstrate the use of
789
770
<application>Apport</application> as this is the recommended way of filing
790
771
Ubuntu or non-KDE related bug reports.
810
791
In the <application>KRunner</application> dialog, enter <userinput>apport-bug -p
811
792
PROGRAM_NAME</userinput>. Replace <emphasis>PROGRAM_NAME</emphasis> with the
812
name of the program you are filing the bug report for. Press
813
<keycap>Enter</keycap> when complete. You will be presented with the following
793
name of the program the bug report is for. Press <keycap>Enter</keycap> when
794
complete. The following dialog will be presented.
817
797
<example><title>Collecting Problem Information</title>
828
When the collection of information has been completed, you will be presented
829
with the following dialog.
808
When the collection of information has been completed, the following dialog
832
812
<example><title>Send problem report to the developers?</title>
902
881
Enter text in the <guilabel>Summary</guilabel> text box that describes the bug
903
882
with a few words. When finished, <mousebutton>Click</mousebutton> the
904
<guibutton>Next</guibutton> button. You will be presented with the following
883
<guibutton>Next</guibutton> button. The following page will be presented.
908
886
<example><title>Report a bug... (Further information)</title>
919
897
Enter text in the <guilabel>Further information</guilabel> text box describing
920
898
the bug in detail. When complete, <mousebutton>Click</mousebutton> the
921
<guibutton>Submit Bug Report</guibutton> button. You will be presented with the
899
<guibutton>Submit Bug Report</guibutton> button. The following page will be
925
903
<example><title>Thank you for your bug report</title>
936
<emphasis role="bold">Congratulations!</emphasis> You just completed a
937
successful non-crash related bug report. Thank you for helping to make &kubuntu;
938
better. You will be notified via e-mail of any updates to the bug report. This
939
allows you to follow along with the progress as well as answer any further
940
questions the developers may have for you.
914
<emphasis role="bold">Congratulations on making a successful non-crash related
915
bug report!</emphasis> Identifying and reporting bugs are essential to improving
916
&kubuntu;. Some emails may be sent to the registered address to update progress
917
or to allow developers to get additional information about the bug.