Project

General

Profile

ReportingBugs » History » Version 2

neels, 04/18/2016 09:43 AM

1 1 laforge
h1. Reporting Bugs
2 1 laforge
3 1 laforge
No software is free of bugs, including Osmocom software.  We do appreciate your bug reports, though of course we can make no guarantees that we will be able to fix it.  It is a volunteer-driven Free Software project, after all.
4 1 laforge
5 1 laforge
In order for us to understand the conditions causing the bug, proper bug reporting is of high importance.
6 1 laforge
7 2 neels
This page intends to provide some input on how to create a bug report that is useful for developers.
8 1 laforge
9 1 laforge
Sending incomplete / insufficient bug reports reduces the probability that the developers can fix the bug you experience, so we kindly ask you to work with us by preparing good bug reports.  Thanks for your attention.
10 1 laforge
11 1 laforge
h2. Important parts of a bug report
12 1 laforge
13 1 laforge
The most important parts of a bug report are
14 1 laforge
# Description of the bug
15 1 laforge
#* what exactly did you try to do?
16 1 laforge
#* what was the expected behavior?
17 1 laforge
#* what was the actual (erroneous) behavior?
18 1 laforge
# Reproducibility
19 1 laforge
#* At which frequency does the bug occur?
20 1 laforge
#* Have you observed any particular condition/trigger/setup that allows to reproduce the bug?
21 1 laforge
# Your setup / environment
22 1 laforge
#* which BTS model/version are you using?
23 1 laforge
#* which of the many Osmocom programs were running at the time of the bug?
24 1 laforge
#** which configuration did you use at the time for each Osmocom program? Include all config files
25 1 laforge
#** which exact version of each Osmocom programs did you use?
26 1 laforge
#* which other external software or hardware components are interfacing with Osmocom
27 1 laforge
#* which exact versions of libosmocore, libosmo-abis, libosmo-netif, etc. did you use?
28 1 laforge
#* if the issue relates to specific phone models, include information about the phone model + firmware/OS version
29 1 laforge
# Protocol Traces
30 1 laforge
#* include a pcap file of the relevant communication interfaces, such as
31 1 laforge
#** Abis/IP between BTS and BSC/NITB (tcp port 3002 + 3003)
32 1 laforge
#** Gb/IP between PCU and SGSN (udp port 23000 by default)
33 1 laforge
#** RUA, HNBAP and/or SUA in case of osmo-iuh / 3G
34 1 laforge
#** The UDP based transceiver interface in case of osmo-trx
35 1 laforge
# Log file output
36 1 laforge
#* The log file output ahead of the bug is very important, include the relevant log file snippets
37 1 laforge
#* If you already suspect/know the bug in a given sub-system, it might make sense to increase the logging verbosity in that sub-system. Please see the respective User Manuals of the Osmocom software you're using.
38 1 laforge
39 1 laforge
h2. Actual bug reporting
40 1 laforge
41 1 laforge
In case you have a user account with sufficient privileges, you can report the bug directly as a redmine issue on this web-site.
42 1 laforge
43 1 laforge
For the general public, bugs are reported via e-mails to one of our mailing lists. Compose an e-mail with as much of the contents listed above, and send it by e-mail to the applicable mailing list.  The subject should preferrably start with "BUG:" 
44 1 laforge
45 1 laforge
The mailing list addresses are as follows:
46 1 laforge
47 1 laforge
* @osmocom-net-gprs@lists.osmocom.org@ for bugs clearly related to the GPRS side of things (like OsmoPCU, OsmoSGSN, OpenGGSN)
48 1 laforge
* @openbsc@lists.osmocom.org@ for the circuit switched side (like OsmoBTS, OsmoBSC, OsmoNITB, ...) or library components.
Add picture from clipboard (Maximum size: 48.8 MB)