How:Efficient Bug Reporting
This documentation explain and; what should we look for when reporting bugs, how we can report a bug efficiently, how bug tracking system can not be used incorrectly.
Before reporting a bug
Before reporting a bug, you should be sure that the problem that you have observed is a bug.For example, before reporting a bug like "my monitor is not working", you should be sure that monitor is on and its cable is plugged in. Try to find a way from e-mail lists and forums. After being sure that this is not a simple problem like mentioned, please control that an update is released about this problem. If an update exist, please update your system and try to reproduce your bug.
- Bugzilla is not an help desk. Please write your questions to mailling lists or forums.
- Please never report a bug that an other person encountered or a bug of about a hardware that you do not have. Because the developers can demand some details about the bug.
- Before reporting the bug please update your system and try to reproduce the bug and keep reproducing steps.
- You are ready for reporting bug, after controlling that the bug has not already been reported. If a similar bug exist, you should follow this bug. You can use this link find a specigfic bug: http://bugs.pardus.org.tr/query.cgi
Efficient Bug Reporting
- A smooth bug report is very important for the developper or maintainer. Therefore, first you have to read bug reporting guide very carefully !!!
- The bug title will be explanatory. Please give a general explanation of the bug like "ATI driver does not work with X", but not give titles like "Problem", "Help", "Attention".
- A template is created in order to report bugs efficiently. This template is prepared for every Pardus user and Pardus test team.
A short explanation of the bug here
Reproducible: (Always, Arbitrarily, For some systems)
Steps to reproduce:
- First step.
- Second step.
- Third step.
You can add your actual results and command outputs here.
You can add expected results accroding to your hardware and devices, and can list necessary device according to bug.
Fixing the bug:
If you think that you fix the bug, you can add your solution or patches.
- An example of efficient bug reporting: http://bugs.pardus.org.tr/show_bug.cgi?id=10043
- If you can't figure out to which product you have to assign the bug but know the name of the application, you can find it with the following command:
pisi sf `which <filename>`
The filename is the name of the file(a configuration file, a library, an executable application, etc.) which seems problematic to you.
Let's assume that the systemsettings application crashes when trying to switch the color scheme but you don't know which package actually ships systemsettings. Just type the command below to find it out:
pisi sf `which systemsettings` Searching for /usr/kde/4/bin/systemsettings Package kdebase-workspace has file usr/kde/4/bin/systemsettings
So this means that, the bug should be assigned to the kdebase-workspace package.
The attachments are also important for developers in order to completely understand the problem
Attention: You have to switch to the root user in order to correctly execute some of the commands below. Type the following command and enter your root password:
For installation bugs:
- Please add:
/var/log/yaliInstall.log file and output of fdisk - l > fdisk.txt to bug report.
For start system bugs:
- If the system can not start, you can keep notes from the screen or take a photo of the screen and report them.
For applicatin bugs:
- Execute the application from console and attach the output of the bug.
For X server bugs:
- Please add these outputs to the bug report:
lspci -nn > lspci.txt dmesg > dmesg.txt lsmod > lsmod.txt
- If keyboard and the computer work, the X server logs are also very important.
cat /var/log/Xorg.0.log > xserver.txt
- If keyboard and the computer do not work, please follow these steps:
Restart your computer, open in vesa mode and take the log.
If X crashed you can take all outputs using this way:
- Press CTRL+ALT+F1 at the same time.(With this command you will pass the system console.)
- Plug a usb stick to your computer.
- Please mount it using this command.
mount /dev/<your_usb_stick_partition> /mnt/flash
- Copy the outputs to usb stick.
cp <output> /mnt/flash
- unmount the usb stick.
For pardus specific applications bugs:
For many situation COMAr log file can be useful:
cat /var/log/comar3/trace.log > comar.txt
To learn network device:
lspci -nn > lspci.txt
Ethernet related bug:
ifconfig -a > ifconfig.txt
Wireless related bugs :
iwconfig > iwconfig.txt
fdisk -l > fdisk.txt cat /etc/fstab > fstab.txt
service -N > service.txt
cat /boot/grub/grub.conf > grub.txt
service -N > service.txt iptables > iptables.txt
For Kamera/video devices bugs:
Please close all camera and video related applications before executing this command.
dmesg > dmesg.txt cat /var/log/syslog > syslog.txt lsusb > lsusb.txt test-webcam > webcam.txt
Execute below command with root and keep note WWW link: