projects / ovs.git / blame
| Commit | Line | Data |
|---|---|---|
| 8b609338 SF |
1 | .. |
| 2 | Licensed under the Apache License, Version 2.0 (the "License"); you may | |
| 3 | not use this file except in compliance with the License. You may obtain | |
| 4 | a copy of the License at | |
| 5 | ||
| 6 | http://www.apache.org/licenses/LICENSE-2.0 | |
| 7 | ||
| 8 | Unless required by applicable law or agreed to in writing, software | |
| 9 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | |
| 10 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | |
| 11 | License for the specific language governing permissions and limitations | |
| 12 | under the License. | |
| 13 | ||
| 14 | Convention for heading levels in Open vSwitch documentation: | |
| 15 | ||
| 16 | ======= Heading 0 (reserved for the title in a document) | |
| 17 | ------- Heading 1 | |
| 18 | ~~~~~~~ Heading 2 | |
| 19 | +++++++ Heading 3 | |
| 20 | ''''''' Heading 4 | |
| 21 | ||
| 22 | Avoid deeper levels because they do not render well. | |
| 23 | ||
| 24 | ============================== | |
| 25 | Reporting Bugs in Open vSwitch | |
| 26 | ============================== | |
| 27 | ||
| 28 | We are eager to hear from users about problems that they have encountered with | |
| 29 | Open vSwitch. This file documents how best to report bugs so as to ensure that | |
| 30 | they can be fixed as quickly as possible. | |
| 31 | ||
| 32 | Please report bugs by sending email to bugs@openvswitch.org. | |
| 33 | ||
| d0e53b15 | 34 | For reporting security vulnerabilities, please read :doc:`security`. |
| 8b609338 SF |
35 | |
| 36 | The most important parts of your bug report are the following: | |
| 37 | ||
| 38 | - What you did that make the problem appear. | |
| 39 | ||
| 40 | - What you expected to happen. | |
| 41 | ||
| 42 | - What actually happened. | |
| 43 | ||
| 44 | Please also include the following information: | |
| 45 | ||
| 46 | - The Open vSwitch version number (as output by ``ovs-vswitchd --version``). | |
| 47 | ||
| 48 | - The Git commit number (as output by ``git rev-parse HEAD``), if you built | |
| 49 | from a Git snapshot. | |
| 50 | ||
| 51 | - Any local patches or changes you have applied (if any). | |
| 52 | ||
| 53 | The following are also handy sometimes: | |
| 54 | ||
| 55 | - The kernel version on which Open vSwitch is running (from ``/proc/version``) | |
| 56 | and the distribution and version number of your OS (e.g. "Centos 5.0"). | |
| 57 | ||
| 58 | - The contents of the vswitchd configuration database (usually | |
| 59 | ``/etc/openvswitch/conf.db``). | |
| 60 | ||
| 61 | - The output of ``ovs-dpctl show``. | |
| 62 | ||
| 63 | - If you have Open vSwitch configured to connect to an OpenFlow | |
| 64 | controller, the output of ``ovs-ofctl show <bridge>`` for each | |
| 65 | ``<bridge>`` configured in the vswitchd configuration database. | |
| 66 | ||
| 67 | - A fix or workaround, if you have one. | |
| 68 | ||
| 69 | - Any other information that you think might be relevant. | |
| 70 | ||
| 71 | .. important:: | |
| 72 | bugs@openvswitch.org is a public mailing list, to which anyone can subscribe, | |
| 73 | so do not include confidential information in your bug report. |