From: Ben Pfaff <blp@nicira.com>
Date: Mon, 13 Sep 2010 16:16:29 +0000 (-0700)
Subject: REPORTING-BUGS: Rewrite based on experience.
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a44be3f0cf616166f550ba65769766a577b4eaf5;p=openvswitch

REPORTING-BUGS: Rewrite based on experience.

Burying the description of the problem, which is usually the most important
part in my experience, at the bottom of the REPORTING-BUGS file might be
the reason why we don't get good descriptions sometimes.  It is certainly
not the reason in other cases, but we might as well prioritize a bit
better.
---

diff --git a/REPORTING-BUGS b/REPORTING-BUGS
index 75da3d6e..812bfba0 100644
--- a/REPORTING-BUGS
+++ b/REPORTING-BUGS
@@ -5,8 +5,17 @@ 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.  Include
-as much of the following information as you can in your report:
+Please report bugs by sending email to bugs@openvswitch.org.  
+
+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").
@@ -16,6 +25,8 @@ as much of the following information as you can in your report:
 
         * 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").
@@ -28,15 +39,7 @@ as much of the following information as you can in your report:
         * 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
-          file.
-
-        * A description of the problem, which should include:
-
-                - What you did that make the problem appear.
-
-                - What you expected to happen.
-
-                - What actually happened.
+          database.
 
         * A fix or workaround, if you have one.