Document how to report bugs in Open vSwitch.
[openvswitch] / REPORTING-BUGS
1 Reporting Bugs in Open vSwitch
2 ==============================
3
4 We are eager to hear from users about problems that they have
5 encountered with Open vSwitch.  This file documents how best to report
6 bugs so as to ensure that they can be fixed as quickly as possible.
7
8 Please report bugs by sending email to bugs@openvswitch.org.  Include
9 as much of the following information as you can in your report:
10
11         * The Open vSwitch version number (as output by "ovs-vswitchd
12           --version").
13
14         * The Git commit number (as output by "git rev-parse HEAD"),
15           if you built from a Git snapshot.
16
17         * Any local patches or changes you have applied (if any).
18
19         * The kernel version on which Open vSwitch is running (from
20           /proc/version) and the distribution and version number of
21           your OS (e.g. "Centos 5.0").
22
23         * The contents of the vswitchd configuration file (usually
24           /etc/ovs-vswitchd.conf).
25
26         * The output of "ovs-dpctl show".
27
28         * If you have Open vSwitch configured to connect to an
29           OpenFlow controller, the output of "ovs-ofctl show <bridge>"
30           for each <bridge> configured in the vswitchd configuration
31           file.
32
33         * A description of the problem, which should include:
34
35                 - What you did that make the problem appear.
36
37                 - What you expected to happen.
38
39                 - What actually happened.
40
41         * A fix or workaround, if you have one.
42
43         * Any other information that you think might be relevant.
44
45 bugs@openvswitch.org is a public mailing list, to which anyone can
46 subscribe, so please do not include confidential information in your
47 bug report.
48
49 Contact 
50 -------
51
52 bugs@openvswitch.org
53 http://openvswitch.org/