Add Bugzilla docs

Mostly imported from the wiki with some editioral cleanup & fact checks
This commit is contained in:
Ben Cotton 2022-03-03 17:05:55 -05:00
parent 3986c1f0f4
commit 96a9a2213f
4 changed files with 131 additions and 1 deletions

View file

@ -1,6 +1,9 @@
* xref:contribute-to-quick-docs.adoc[Contribute to Quick Docs]
* xref:howto-file-a-bug.adoc[How to file a bug]
* Bugs
** xref:howto-file-a-bug.adoc[How to file a bug]
** xref:bugzilla/query.adoc[Bugzilla queries]
** xref:bugzilla/find-duplicates.adoc[Finding duplicate bugs]
* xref:getting-started-guide.adoc[Getting started with Fedora]

View file

@ -0,0 +1,74 @@
= Finding the correct component
When filing a bug, it helps if you can identify the component at fault.
This is not always obvious, so here are some tips.
== Which program is it?
If you started the program from the GNOME menu, you can usually find the name of the program by going to "Help -> About" in the program's internal menus.
You can also go to "System -> Preferences -> Personal -> Sessions" on the GNOME menu. Click on the "Current Session" tab to see a list of programs running on your desktop.
If you started the program from the command line, the name of the program is the first "word" of the command (everything before the first space, which might include dashes or underscores).
If you want to find out exactly what command a specific menu item will run, in GNOME you can do the following:
. Right-click on the menu item and select "Add this launcher to panel"
. Right-click on the icon that appears on your panel and select "Properties"
. Record the "Command" field, then close the Properties window.
. Right-click on the panel icon again and select "Remove from panel" to put things back the way they were when you started.
== Which file is it?
If you know which command was run, but don't know the exact file name this corresponds to, try this on the command line:
which <command-name>
The first line in the results is the one you want.
For example:
$ which ssh
/usr/bin/ssh
== Which package is it?
Once you have the name of a file or directory, you can determine which package owns it using "rpm -qf".
For example:
$ rpm -qf /usr/bin/nautilus-file-management-properties
nautilus-2.25.91-2.fc11.x86_64
You should include the full name and version number of this package in your bug report.
== Which component is it?
In Fedora Linux, a given "source" RPM can produce multiple RPMs in the distribution.
Bugzilla groups bugs according to the "source" RPMs.
Once you have the RPM name, you can get the "source" RPM name (which might be different) using "rpm -qi".
For example, run `rpm -qi glibc-common` and then look for the line that says "Source RPM:"
In this case, it's "glibc-2.9.90-7.src.rpm", which means the component name to use in Bugzilla is "glibc" (everything before the dash before the version number).
$ rpm -qi glibc-common
...
Group : System Environment/Base
Source RPM: glibc-2.11-2.src.rpm
NOTE: If the "Vendor:" line does not say "Fedora Project", you may need to report the bug to a different project's bug tracker.
== If you don't have package installed
For packages which you have NOT installed you can use dnf's repoquery command:
repoquery -f /usr/bin/kdm
will find you which binary package contains the kdm executable.
To find the component that provides the binary package you found above, run:
repoquery -q --qf="%{sourcerpm}\n" kdm
== Embedded components
Sometimes it can be unclear whether a bug is in the main application or a plugin or library.
In these cases, just make your best guess.
A triager or developer will reassign the bug if necessary.

View file

@ -0,0 +1,20 @@
= Finding duplicates in Bugzilla
include::partial$attributes.adoc[]
Fedora developers want to hear about specific and reproducible bugs that happen when you use Fedora Linux, but it does not help to have the same bug reported many times.
You can help to get more bugs fixed faster by checking duplicate reports before filing a new bug.
Commonly encountered bugs can be found:
* On the https://bugzilla.redhat.com/duplicates.cgi?sortby=count&reverse=1&product=Fedora&maxrows=100&changedsince=7[most frequently reported bugs] list
* On the https://fedoraproject.org/wiki/Bugs/Common[Common Bugs] page
For Rawhide bugs, linked from a https://fedoraproject.org/wiki/BugZappers/HouseKeeping/Trackers[Blocker or Target Tracker]
If your bug isn't in the lists above, you can use xref:bugzilla/query.adoc[Bugzilla's search tool] to find matching bugs.
== What to do with duplicates once found
If you are a triager or package maintainer, set the bug that has less information to the CLOSED status with a resolution of DUPLICATE, and add the bug number of the bug with the best information.
This may very well mean closing a lower-numbered bug and keeping a higher-numbered one open—that's fine.
If you do not have permissions to change bugs you have not reported, add a comment to both bugs pointing out the duplication and someone else will mark them appropriately.

View file

@ -0,0 +1,33 @@
= Bugzilla queries
Bugzilla lets you search for bug reports that match specified conditions.
This page covers common options.
The https://bugzilla.redhat.com/docs/en/html/using/index.html[Red Hat Bugzilla User Guide] has more information.
== Simple queries
The https://bugzilla.redhat.com/query.cgi?format=specific[simple Bugzilla query form] does a relatively simple keyword search.
Enter a word or short phrase that identifies the problem you saw as uniquely as possible in the Summary field.
Examples: "view source", "auto proxy", "drag drop", "png image".
== Advanced queries
The https://bugzilla.redhat.com/query.cgi?format=advanced[advanced Bugzilla query form] looks dauntingly complex.
While it is complex and powerful, you can safely ignore most of the form.
Any part of the form that is left blank does not limit the search.
Each part that is filled in cuts the list of bugs down to only those that match the criteria you set.
The Status field is set by default to find NEW, ASSIGNED, NEEDINFO, and MODIFIED bugs—the unfixed bugs (or in the case of MODIFIED the recently fixed bugs).
In the product field, you should always use "Fedora", "Fedora EPEL", or "Fedora Container Images".
In the component field, select the source package that contains the defect.
See the xref:bugzilla/correct-component[finding the correct component] for help.
Enter a word or short phrase that identifies the problem you saw as uniquely as possible in the Summary field.
Examples: "view source", "auto proxy", "drag drop", "png image".
If you enter more than one word and they are not a phrase, change the type of matching for the Summary field from *contains the string* to *contains all of the words/strings* or *contains any of the words/strings*, as appropriate.
Fedora generally doesn't make use of keywords in Bugzilla, so you won't usually need to use this.
Keywords are specific tags, not arbitrary words.
If you try to search for keywords that are not on the list, it won't work.