diff options
| -rw-r--r-- | Makefile.am | 2 | ||||
| -rw-r--r-- | REPORTING-BUGS.md | 58 | ||||
| -rw-r--r-- | REPORTING-BUGS.rst | 73 | ||||
| -rw-r--r-- | SECURITY.md | 2 |
4 files changed, 75 insertions, 60 deletions
diff --git a/Makefile.am b/Makefile.am index baba719da..fd17207e1 100644 --- a/Makefile.am +++ b/Makefile.am @@ -93,7 +93,7 @@ docs = \ README.rst \ README-lisp.md \ README-native-tunneling.md \ - REPORTING-BUGS.md \ + REPORTING-BUGS.rst \ SECURITY.md \ WHY-OVS.md EXTRA_DIST = \ diff --git a/REPORTING-BUGS.md b/REPORTING-BUGS.md deleted file mode 100644 index c046af95d..000000000 --- a/REPORTING-BUGS.md +++ /dev/null @@ -1,58 +0,0 @@ -Reporting Bugs in Open vSwitch -============================== - -We are eager to hear from users about problems that they have -encountered with Open vSwitch. This file documents how best to report -bugs so as to ensure that they can be fixed as quickly as possible. - -Please report bugs by sending email to bugs@openvswitch.org. - -For reporting security vulnerabilities, please read SECURITY.md. - -The most important parts of your bug report are the following: - - * What you did that make the problem appear. - - * What you expected to happen. - - * What actually happened. - -Please also include the following information: - - * The Open vSwitch version number (as output by `ovs-vswitchd - --version`). - - * The Git commit number (as output by `git rev-parse HEAD`), - if you built from a Git snapshot. - - * Any local patches or changes you have applied (if any). - -The following are also handy sometimes: - - * The kernel version on which Open vSwitch is running (from - `/proc/version`) and the distribution and version number of - your OS (e.g. "Centos 5.0"). - - * The contents of the vswitchd configuration database (usually - `/etc/openvswitch/conf.db`). - - * The output of `ovs-dpctl show`. - - * If you have Open vSwitch configured to connect to an - OpenFlow controller, the output of `ovs-ofctl show <bridge>` - for each `<bridge>` configured in the vswitchd configuration - database. - - * A fix or workaround, if you have one. - - * Any other information that you think might be relevant. - -bugs@openvswitch.org is a public mailing list, to which anyone can -subscribe, so please do not include confidential information in your -bug report. - -Contact -------- - -bugs@openvswitch.org -http://openvswitch.org/ diff --git a/REPORTING-BUGS.rst b/REPORTING-BUGS.rst new file mode 100644 index 000000000..73e0df3d3 --- /dev/null +++ b/REPORTING-BUGS.rst @@ -0,0 +1,73 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + + Convention for heading levels in Open vSwitch documentation: + + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + + Avoid deeper levels because they do not render well. + +============================== +Reporting Bugs in Open vSwitch +============================== + +We are eager to hear from users about problems that they have encountered with +Open vSwitch. This file documents how best to report bugs so as to ensure that +they can be fixed as quickly as possible. + +Please report bugs by sending email to bugs@openvswitch.org. + +For reporting security vulnerabilities, please read SECURITY.md. + +The most important parts of your bug report are the following: + +- What you did that make the problem appear. + +- What you expected to happen. + +- What actually happened. + +Please also include the following information: + +- The Open vSwitch version number (as output by ``ovs-vswitchd --version``). + +- The Git commit number (as output by ``git rev-parse HEAD``), if you built + from a Git snapshot. + +- Any local patches or changes you have applied (if any). + +The following are also handy sometimes: + +- The kernel version on which Open vSwitch is running (from ``/proc/version``) + and the distribution and version number of your OS (e.g. "Centos 5.0"). + +- The contents of the vswitchd configuration database (usually + ``/etc/openvswitch/conf.db``). + +- The output of ``ovs-dpctl show``. + +- If you have Open vSwitch configured to connect to an OpenFlow + controller, the output of ``ovs-ofctl show <bridge>`` for each + ``<bridge>`` configured in the vswitchd configuration database. + +- A fix or workaround, if you have one. + +- Any other information that you think might be relevant. + +.. important:: + bugs@openvswitch.org is a public mailing list, to which anyone can subscribe, + so do not include confidential information in your bug report. diff --git a/SECURITY.md b/SECURITY.md index 624715332..4cc4ed6ee 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -65,7 +65,7 @@ A security team member should reply to the reporter acknowledging that the report has been received. Please consider reporting the information mentioned in -REPORTING-BUGS.md, where relevant. +REPORTING-BUGS.rst, where relevant. Reporters may ask for a GPG key while initiating contact with the security team to deliver more sensitive reports. |