1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
4
<!ENTITY % globalent SYSTEM "../../../libs/global.ent">
6
<!ENTITY % kde-menus-C SYSTEM "../../../libs/kde-menus-C.ent">
8
<!ENTITY language "en">
17
>This document provides step-by-step procedures for filing &kubuntu; bug reports. </para>
23
>Types of Bug Reports</title>
25
>Generally, there are three types of bug reports: <emphasis
30
>feature request</emphasis
34
>Overview of bug types</title>
40
>An application or system crash or failure. Most of the time, a crash dialog will be presented that can be turned into a bug report. </para>
48
>A bug or regression that doesn't cause the application to crash, but does cause the application to stop functioning properly. </para>
53
>Feature request</term>
56
>Also known as a wish list item, this type of report is filed to add a function to an application, or to change something in the application that isn't due to a regression or a crash. </para>
62
<sect1 id="bug-trackers">
64
>Bug Trackers Used By &kubuntu;</title>
65
<sect2 id="bug-trackers-kde">
67
>KDE's Bug Tracking System</title>
69
><ulink url="https://bugs.kde.org/"
73
>KDE uses Bugzilla, a "Defect Tracking System". Bugzilla is one of the most popular tools used in the open source development community. </para>
76
>Register first</title>
78
>To report a bug, one must register for an account on KDE's Bugzilla at <ulink url="https://bugs.kde.org/createaccount.cgi"
80
>. A valid email address is required for registration. </para>
84
>Only for KDE bugs</title>
86
>Bugzilla is only for KDE bugs. If the application is not part of KDE, for instance Firefox, LibreOffice, or VLC, then the report should be filed in Launchpad instead. Please see the next section, which covers filing reports concerning Launchpad. </para>
89
<sect2 id="bug-trackers-lp">
93
><ulink url="https://launchpad.net/"
97
>Launchpad is an open source suite of tools that help people and teams to work together on software projects. Launchpad is used by the Ubuntu and &kubuntu; Projects, as well as various other open source projects. </para>
100
>Register first</title>
102
>To report a bug, one must register for a Launchpad account at <ulink url="https://launchpad.net/+login"
104
>. A valid email address is required for registration. </para>
108
>For any bug in &kubuntu;</title>
110
>Launchpad can be used to file a bug report for any application available in the Ubuntu or &kubuntu; repositories. For KDE applications, the KDE Bug Tracking system (above) is preferred. </para>
115
<sect1 id="filing-crash">
117
>Filing a Crash Report</title>
119
>When an application crashes in &kubuntu;, the appropriate crash dialog will appear. It is usually easy to file a bug report from the dialog. With a KDE application, the KDE crash dialog will appear along with instructions for reporting the bug. Otherwise, the Ubuntu crash dialog will appear with instructions for filing a bug on Launchpad. </para>
120
<sect2 id="filing-crash-kde">
124
>When an application crashes in KDE, a crash dialog will be presented that is similar to the following images. The first image shows the <guilabel
126
> tab which provides an overview of the crash. The second image shows the <guilabel
127
>Developer Information</guilabel
128
> tab which provides trace information that is useful to developers. </para>
132
>KDE Crash Dialog (General tab)</title>
135
<imagedata fileref="help:/images/C/crash_dialog_general_tab.png" format="PNG"/>
143
>KDE Crash Dialog (Developer Information tab)</title>
146
<imagedata fileref="help:/images/C/crash_dialog_devinfo_tab.png" format="PNG"/>
152
>If the trace information is deemed valuable, filing a bug report is easy with the crash dialog wizard. If the trace is not deemed valuable, then it is not possible to file a bug report with the wizard. The bug report can still be filed manually at <ulink url="https://bugs.kde.org/"
156
>To complete the bug reporting process, follow the procedure below. </para>
159
>Filing the bug report after a crash</title>
165
>Report Bug</guibutton
166
> button. The following dialog will appear. </para>
170
>Welcome to the Reporting Assistant</title>
173
<imagedata fileref="help:/images/C/crash_report_assistant_welcome.png" format="PNG"/>
185
> button. The following dialog will appear. </para>
189
>What do you know about the crash?</title>
192
<imagedata fileref="help:/images/C/crash_report_assistant_about_crash.png" format="PNG"/>
200
>Select the applicable options. The drop-down box under the question, "<guilabel
201
>Does the application crash again if you repeat the same situation?</guilabel
202
>" has several options. </para>
206
>Does the application crash again if you repeat the same situation?</title>
209
<imagedata fileref="help:/images/C/crash_report_assistant_about_crash_dropdown.png" format="PNG"/>
217
>After selecting the applicable items from the dialog in the previous step, <mousebutton
225
>Depending on the information available in the crash report, either of two dialogs will appear. One is a dialog that indicates that there is not enough information to file a good report. The other is a dialog indicating that the information is useful, and that it would be helpful to continue with filing the report. </para>
229
>Not enough information for developers to continue the reporting process</title>
232
<imagedata fileref="help:/images/C/crash_report_assistant_not_enough_info.png" format="PNG"/>
240
>This crash information is useful</title>
243
<imagedata fileref="help:/images/C/crash_report_assistant_useful_information.png" format="PNG"/>
250
>If there was not enough information...</title>
252
>It may be necessary to install the proper debug packages in order to get a good trace. Such packages include <filename
253
>kdebase-dbg</filename
255
>kdebase-workspace-dbg</filename
257
>kdebase-runtime-dbg</filename
263
>If enough information was provided to continue filing a bug report using the assistant, a dialog will appear to allow logging in to KDE's Bugzilla. </para>
267
>KDE Bug Tracking System Login</title>
270
<imagedata fileref="help:/images/C/crash_report_assistant_bugtracker_login.png" format="PNG"/>
277
>Use e-mail address as username</title>
279
>Use the e-mail address that was used to register with KDE's Bugzilla. </para>
284
>After logging in with username (e-mail address) and password, <mousebutton
288
> button. The assistant will check for duplicates and display the following dialog. </para>
292
>Bug Report Possible Duplicates List</title>
295
<imagedata fileref="help:/images/C/crash_report_assistant_possible_duplicates.png" format="PNG"/>
303
>If there is a possible duplicate report, <mousebutton
305
> the report in the list and then <mousebutton
308
>Open selected report</guibutton
309
> button. Either of the following dialogs will be presented. </para>
313
>The report you selected is already marked as a duplicate of bug...</title>
316
<imagedata fileref="help:/images/C/crash_report_assistant_nested_duplicate_detected.png" format="PNG"/>
324
>Showing the duplicate bug report you selected</title>
327
<imagedata fileref="help:/images/C/crash_report_assistant_duplicate_report.png" format="PNG"/>
335
>If the bug appears to be a duplicate, <mousebutton
338
>Add as a possible duplicate</guibutton
339
> button. This will file the bug report and inform the developers that it may be a duplicate. This is recommended, except in cases with experienced users where it is clearly not a duplicate. <mousebutton
340
>Clicking</mousebutton
342
>Attach to this report (Advanced)</guibutton
343
> will attach the crash information to the report. </para>
345
>If the bug is not a duplicate, simply <mousebutton
349
> in the dialog showing the possible duplicates. A dialog will appear with <guibutton
350
>Let me check more reports</guibutton
351
>. To prevent checking for more reports and continue to file the report, <mousebutton
354
>There are no real duplicates</guibutton
355
> button. A dialog will appear to enter additional information concerning the report. </para>
359
>Details of the Bug Report</title>
362
<imagedata fileref="help:/images/C/crash_report_assistant_report_details.png" format="PNG"/>
370
>Once the details of the bug report are complete, <mousebutton
374
> button. The following dialog will be presented. </para>
378
>Preview Report</title>
381
<imagedata fileref="help:/images/C/crash_report_assistant_report_details_preview.png" format="PNG"/>
389
>If the information looks correct, <mousebutton
393
> button. The following dialog will be presented. </para>
397
>Send Crash Report</title>
400
<imagedata fileref="help:/images/C/crash_report_assistant_report_filed.png" format="PNG"/>
408
><emphasis role="bold"
409
>Congratulations on a successful bug report!</emphasis
410
> Identifying and reporting bugs are essential to improving &kubuntu; and KDE. Some emails may be sent to the registered address to update progress or to allow developers to get additional information about the bug. </para>
412
<sect2 id="filing-crash-lp">
416
>When an application that is not KDE crashes in &kubuntu;, a pop-up notification will appear from <application
418
> that is similar to the following image. </para>
422
>Apport Crash Pop-pup Notification</title>
425
<imagedata fileref="help:/images/C/apport-notification.png" format="PNG"/>
432
>Crash information may be different</title>
434
>The following screen shots were created by crashing the application <application
436
> deliberately. Crash dialogs associated with other applications will be different. In an actual bug situation, the application name, <application
438
>, will be replaced by the name of the application that actually crashed. </para>
441
>To complete the bug reporting process, follow the procedure below. </para>
444
>Filing the bug report after a crash</title>
451
> buttons on the <application
452
>System Notification Helper</application
453
>. The following dialog will be presented. </para>
457
>Sorry, the program "vlc" closed unexpectedly.</title>
460
<imagedata fileref="help:/images/C/apport-dialog-1.png" format="PNG"/>
471
>Report Problem...</guibutton
472
> button. The <guilabel
473
>Collecting Problem Information</guilabel
474
> progress dialog will be presented. </para>
478
>Collecting Problem Information</title>
481
<imagedata fileref="help:/images/C/apport-dialog-collecting-info.png"
490
>After all of the information concerning the crash is collected, a dialog will be presented that displays the details of the report, and the report is sent to the developers. <mousebutton
493
>Details...</guibutton
494
> button to view details of the report. The following dialog will be presented. </para>
498
>Send problem report to the developers? (Details)</title>
501
<imagedata fileref="help:/images/C/apport-dialog-details.png" format="PNG"/>
513
> button to send the report to the developers. In this case, it will send the report to Launchpad. The following progress dialog will be presented. </para>
517
>Uploading problem information</title>
520
<imagedata fileref="help:/images/C/apport-dialog-uploading.png" format="PNG"/>
528
>After the progress dialog completes, the default web browser will open to Launchpad presenting either the login page or the beginning of the online version of the bug reporting process. After logging in (if necessary) the following page will be presented. </para>
532
>Please wait while bug data is processed...</title>
535
<imagedata fileref="help:/images/C/apport-browser-processing.png" format="PNG"/>
543
>When Launchpad is finished processing the bug data, the following page will be presented. </para>
547
>Extra debug information will be added...</title>
550
<imagedata fileref="help:/images/C/apport-browser-step-1.png" format="PNG"/>
562
> button. The following page will be presented. </para>
566
>Further information</title>
569
<imagedata fileref="help:/images/C/apport-browser-step-2.png" format="PNG"/>
577
>Any extra information can be filled in about the bug report such as what was being done when it crashed or the online file locations that may have caused the crash. The following is a brief description filed with the report in this procedure. </para>
581
>Further information (Completed)</title>
584
<imagedata fileref="help:/images/C/apport-browser-step-3.png" format="PNG"/>
595
>Submit Bug Report</guibutton
596
> button on the bottom of the page. The following page will be presented. </para>
600
>Thank you for your bug report</title>
603
<imagedata fileref="help:/images/C/apport-browser-step-4.png" format="PNG"/>
611
><emphasis role="bold"
612
>Congratulations on making a successful crash report!</emphasis
613
>Identifying and reporting bugs are essential to improving &kubuntu;. Some emails may be sent to the registered address to update progress or to allow developers to get additional information about the bug. </para>
617
<sect1 id="filing-non-crash">
619
>Filing a Non-Crash or Regression Report</title>
621
>If an application has regressed in functionality, a bug report should be filed on that application. A regress occurs when a function worked in a previous release but in the latest release, it is not working. In most cases, this type of report will be filed by those who have more experience and may be testing beta quality software. However there are situations where a user needs to report an issue with an application that isn't working right, but isn't crashing. The following procedures will help. </para>
622
<sect2 id="filing-non-crash-kde">
626
>Filing non-crash related bug reports for KDE applications are done with a web browser using <ulink url="https://bugs.kde.org/"
631
>Register first</title>
633
>To report a bug, one must register for an account on the bug tracker. KDE's bug tracker is located at <ulink url="https://bugs.kde.org/"
639
>Filing a bug report without a crash</title>
642
>In a web browser, go to <ulink url="https://bugs.kde.org/"
644
> and either create a new account or login. Once logged in, the following page will be presented. </para>
648
>Welcome to the KDE Bug Tracking System</title>
651
<imagedata fileref="help:/images/C/kde-bugreport-nc-step-1.png" format="PNG"/>
662
>Report New Wish or Bug</guilabel
663
> link in the top-right-hand corner of the page to start the process of filing the bug report. The following page will be presented. </para>
667
>Welcome to the KDE Bug Report Wizard!</title>
670
<imagedata fileref="help:/images/C/kde-bugreport-nc-step-2.png" format="PNG"/>
682
> button. The following page will be presented. </para>
686
>Software Configuration</title>
689
<imagedata fileref="help:/images/C/kde-bugreport-nc-step-3.png" format="PNG"/>
697
>Select the proper <guilabel
698
>KDE Version</guilabel
699
> (required) and the <guilabel
700
>Distribution Method</guilabel
701
> (Should be <guilabel
702
>Ubuntu Packages</guilabel
703
>) from the drop-down menus. <mousebutton
707
> button when finished with the selections. The following page will be presented. </para>
711
>Application Selection</title>
714
<imagedata fileref="help:/images/C/kde-bugreport-nc-step-4a.png" format="PNG"/>
722
>If the application being reported is in the <guilabel
723
>Application</guilabel
724
> list, select it and press the <guibutton
726
> button. If the application is not in the list, skip to the next step. </para>
732
> section under the <guilabel
733
>Application</guilabel
734
> list, fill in the <guilabel
735
>Keyword Search</guilabel
736
> text box with the application being reported. It should look similar to the following image. </para>
740
>Application Selection (Search for application)</title>
743
<imagedata fileref="help:/images/C/kde-bugreport-nc-step-4b.png" format="PNG"/>
749
>If the application is located, a page will be displayed similar to the previous one with the application highlighted. </para>
757
> button. The following page will be presented. </para>
761
>General Information</title>
764
<imagedata fileref="help:/images/C/kde-bugreport-nc-step-5.png" format="PNG"/>
774
> text box, enter the summary with information similar to the example under the text box. Select <guilabel
777
>Operating System</guilabel
778
> drop-down menu. When completed, <mousebutton
782
> button. The following page will be presented. </para>
786
>Check for Duplicate Bug Reports</title>
789
<imagedata fileref="help:/images/C/kde-bugreport-nc-step-6.png" format="PNG"/>
797
>If a duplicate report is found, click on that report ID to view the report. If it is a duplicate and more information is needed, then simply enter text in the large text box confirming it. If more information is not needed, nothing need be entered. If no duplicate reports are found, <mousebutton
801
> button. The following page will be presented. </para>
805
>Bug Entry Form</title>
808
<imagedata fileref="help:/images/C/kde-bugreport-nc-step-7.png" format="PNG"/>
818
> (required) drop-down menu should display the <guilabel
819
>Bug - Bug report (no crashes)</guilabel
820
> option. In the <guilabel
821
>Long Description in English</guilabel
822
> (required) text box, enter all information pertaining to the bug report. When completed, <mousebutton
826
> button. The following page will be presented. </para>
830
>Bug Submitted</title>
833
<imagedata fileref="help:/images/C/kde-bugreport-nc-step-8.png" format="PNG"/>
841
><emphasis role="bold"
842
>Congratulations on making a successful non-crash related bug report!</emphasis
843
> Identifying and reporting bugs are essential to improving &kubuntu; and KDE. Some emails may be sent to the registered address to update progress or to allow developers to get additional information about the bug. </para>
845
<sect2 id="filing-non-crash-lp">
849
>Filing non-crash related bug reports in non-KDE applications can be done either by going to <ulink url="https://bugs.launchpad.net/ubuntu/+filebug"
851
> in a web browser or by using the <application
853
> bug reporting application. The following procedure will demonstrate the use of <application
855
> as this is the recommended way of filing Ubuntu or non-KDE related bug reports. </para>
858
>Filing a bug report without a crash</title>
862
>KRunner</application
863
>, the KDE run command interface, by pressing <keycombo
876
<imagedata fileref="help:/images/C/lp-bugreport-nc-step-1a.png" format="PNG"/>
885
>KRunner</application
886
> dialog, enter <userinput
887
>apport-bug -p PROGRAM_NAME</userinput
889
>PROGRAM_NAME</emphasis
890
> with the name of the program the bug report is for. Press <keycap
892
> when complete. The following dialog will be presented. </para>
896
>Collecting Problem Information</title>
899
<imagedata fileref="help:/images/C/lp-bugreport-nc-step-1b.png" format="PNG"/>
907
>When the collection of information has been completed, the following dialog will be presented. </para>
911
>Send problem report to the developers?</title>
914
<imagedata fileref="help:/images/C/lp-bugreport-nc-step-2.png" format="PNG"/>
925
>Details...</guibutton
926
> button to see details of the report to be followed. The following dialog will be presented. </para>
930
>Report Details</title>
933
<imagedata fileref="help:/images/C/lp-bugreport-nc-step-2a.png" format="PNG"/>
945
> button to send the report to the developers. The following progress dialog will be presented. </para>
949
>Uploading Problem Information</title>
952
<imagedata fileref="help:/images/C/lp-bugreport-nc-step-2b.png" format="PNG"/>
960
>After the information has been uploaded, the web browser will open and display a page similar to the following. </para>
964
>Please wait while bug data is processed.</title>
967
<imagedata fileref="help:/images/C/lp-bugreport-nc-step-2c.png" format="PNG"/>
973
>After the bug data is processed, the following page will be presented. </para>
977
>Report a bug... (Summary)</title>
980
<imagedata fileref="help:/images/C/lp-bugreport-nc-step-3.png" format="PNG"/>
988
>Enter text in the <guilabel
990
> text box that describes the bug with a few words. When finished, <mousebutton
994
> button. The following page will be presented. </para>
998
>Report a bug... (Further information)</title>
1001
<imagedata fileref="help:/images/C/lp-bugreport-nc-step-4.png" format="PNG"/>
1009
>Enter text in the <guilabel
1010
>Further information</guilabel
1011
> text box describing the bug in detail. When complete, <mousebutton
1014
>Submit Bug Report</guibutton
1015
> button. The following page will be presented. </para>
1019
>Thank you for your bug report</title>
1022
<imagedata fileref="help:/images/C/lp-bugreport-nc-step-5.png" format="PNG"/>
1030
><emphasis role="bold"
1031
>Congratulations on making a successful non-crash related bug report!</emphasis
1032
> Identifying and reporting bugs are essential to improving &kubuntu;. Some emails may be sent to the registered address to update progress or to allow developers to get additional information about the bug. </para>
1036
<sect1 id="filing-wishlist">
1038
>Filing a Feature Request or Wishlist Report</title>
1040
>The easiest way to request a new feature in either an application or the operating system is to file a bug, otherwise known as a wishlist report. </para>
1041
<sect2 id="filing-wishlist-kde">
1045
>Filing a feature request report in KDE is exactly the same as filing a <link linkend="filing-non-crash-kde"
1046
>non-crash KDE bug report</link
1049
<sect2 id="filing-wishlist-lp">
1053
>Filing a wishlist report for &kubuntu; is exactly the same as filing a <link linkend="filing-non-crash-lp"
1054
>non-crash Launchpad bug report</link
1063
sgml-minimize-attributes:nil
1064
sgml-general-insert-case:lower
1066
sgml-indent-data:nil
1069
vim: tabstop=2:shiftwidth=2:expandtab:indentexpr=:tw=80:
1070
kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;