Project

General

Profile

ReportingBugs » History » Version 3

laforge, 08/19/2017 09:59 AM

1 3 laforge
{{>toc}}
2
3 1 laforge
h1. Reporting Bugs
4
5
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.
6
7
In order for us to understand the conditions causing the bug, proper bug reporting is of high importance.
8
9 2 neels
This page intends to provide some input on how to create a bug report that is useful for developers.
10 1 laforge
11
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.
12
13
h2. Important parts of a bug report
14
15
The most important parts of a bug report are
16
# Description of the bug
17
#* what exactly did you try to do?
18
#* what was the expected behavior?
19
#* what was the actual (erroneous) behavior?
20
# Reproducibility
21
#* At which frequency does the bug occur?
22
#* Have you observed any particular condition/trigger/setup that allows to reproduce the bug?
23
# Your setup / environment
24
#* which BTS model/version are you using?
25
#* which of the many Osmocom programs were running at the time of the bug?
26
#** which configuration did you use at the time for each Osmocom program? Include all config files
27
#** which exact version of each Osmocom programs did you use?
28
#* which other external software or hardware components are interfacing with Osmocom
29
#* which exact versions of libosmocore, libosmo-abis, libosmo-netif, etc. did you use?
30
#* if the issue relates to specific phone models, include information about the phone model + firmware/OS version
31
# Protocol Traces
32
#* include a pcap file of the relevant communication interfaces, such as
33
#** Abis/IP between BTS and BSC/NITB (tcp port 3002 + 3003)
34
#** Gb/IP between PCU and SGSN (udp port 23000 by default)
35
#** RUA, HNBAP and/or SUA in case of osmo-iuh / 3G
36
#** The UDP based transceiver interface in case of osmo-trx
37
# Log file output
38
#* The log file output ahead of the bug is very important, include the relevant log file snippets
39
#* 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.
40
41
h2. Actual bug reporting
42
43
In case you have a user account with sufficient privileges, you can report the bug directly as a redmine issue on this web-site.
44
45
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:" 
46
47
The mailing list addresses are as follows:
48
49
* @osmocom-net-gprs@lists.osmocom.org@ for bugs clearly related to the GPRS side of things (like OsmoPCU, OsmoSGSN, OpenGGSN)
50
* @openbsc@lists.osmocom.org@ for the circuit switched side (like OsmoBTS, OsmoBSC, OsmoNITB, ...) or library components.
51 3 laforge
52
h2. Video Tutorial
53
54
At [[osmo-dev-con:OsmoCon2017]], Daniel Willmann gave a presentation on "how to report issues to osmocom":https://media.ccc.de/v/osmocon17-4008-reporting_and_investigating_issues_in_osmocom
Add picture from clipboard (Maximum size: 48.8 MB)