doc: Convert docs to Markdown language
[cascardo/ovs.git] / REPORTING-BUGS.md
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.  
9
10 The most important parts of your bug report are the following:
11
12   * What you did that make the problem appear.
13
14   * What you expected to happen.
15
16   * What actually happened.
17
18 Please also include the following information:
19
20   * The Open vSwitch version number (as output by `ovs-vswitchd
21     --version`).
22
23   * The Git commit number (as output by `git rev-parse HEAD`),
24     if you built from a Git snapshot.
25
26   * Any local patches or changes you have applied (if any).
27
28 The following are also handy sometimes:
29
30   * The kernel version on which Open vSwitch is running (from
31     `/proc/version`) and the distribution and version number of
32     your OS (e.g. "Centos 5.0").
33
34   * The contents of the vswitchd configuration database (usually
35     `/etc/openvswitch/conf.db`).
36
37   * The output of `ovs-dpctl show`.
38
39   * If you have Open vSwitch configured to connect to an
40     OpenFlow controller, the output of `ovs-ofctl show <bridge>`
41     for each `<bridge>` configured in the vswitchd configuration
42     database.
43
44   * A fix or workaround, if you have one.
45
46   * Any other information that you think might be relevant.
47
48 bugs@openvswitch.org is a public mailing list, to which anyone can
49 subscribe, so please do not include confidential information in your
50 bug report.
51
52 Contact 
53 -------
54
55 bugs@openvswitch.org
56 http://openvswitch.org/