From patchwork Tue Oct 18 20:03:36 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 683850 X-Patchwork-Delegate: rbryant@redhat.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from archives.nicira.com (archives.nicira.com [96.126.127.54]) by ozlabs.org (Postfix) with ESMTP id 3sz5gG2YwMz9s2G for ; Wed, 19 Oct 2016 07:06:18 +1100 (AEDT) Authentication-Results: ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b=Pof/aWly; dkim-atps=neutral Received: from archives.nicira.com (localhost [127.0.0.1]) by archives.nicira.com (Postfix) with ESMTP id 7E68210315; Tue, 18 Oct 2016 13:06:17 -0700 (PDT) X-Original-To: dev@openvswitch.org Delivered-To: dev@openvswitch.org Received: from mx3v3.cudamail.com (mx3.cudamail.com [64.34.241.5]) by archives.nicira.com (Postfix) with ESMTPS id CF87E1030A for ; Tue, 18 Oct 2016 13:06:16 -0700 (PDT) Received: from bar6.cudamail.com (localhost [127.0.0.1]) by mx3v3.cudamail.com (Postfix) with ESMTPS id 66861162A9C for ; Tue, 18 Oct 2016 14:06:16 -0600 (MDT) X-ASG-Debug-ID: 1476821175-0b3237781826d90001-byXFYA Received: from mx3-pf1.cudamail.com ([192.168.14.2]) by bar6.cudamail.com with ESMTP id B8sv8Y8MSYqtf3I4 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Tue, 18 Oct 2016 14:06:15 -0600 (MDT) X-Barracuda-Envelope-From: stephen@that.guru X-Barracuda-RBL-Trusted-Forwarder: 192.168.14.2 Received: from unknown (HELO camel.maple.relay.mailchannels.net) (23.83.214.29) by mx3-pf1.cudamail.com with ESMTPS (DHE-RSA-AES256-SHA encrypted); 18 Oct 2016 20:06:12 -0000 Received-SPF: none (mx3-pf1.cudamail.com: domain at that.guru does not designate permitted sender hosts) X-Barracuda-Apparent-Source-IP: 23.83.214.29 X-Barracuda-RBL-IP: 23.83.214.29 X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id 672091BD412 for ; Tue, 18 Oct 2016 20:06:11 +0000 (UTC) Received: from one.mxroute.com (ip-10-107-69-155.us-west-2.compute.internal [10.107.69.155]) by relay.mailchannels.net (Postfix) with ESMTPA id AB90F1BCDBE for ; Tue, 18 Oct 2016 20:06:10 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com ([TEMPUNAVAIL]. [10.135.9.54]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.7.8); Tue, 18 Oct 2016 20:06:11 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: mxroute X-MC-Loop-Signature: 1476821170947:1596201151 X-MC-Ingress-Time: 1476821170947 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru; s=default; h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: Sender:Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=/jxg/Oday4l/xipq+zOeIr9rdmbfOGMqoI6jZmWbp6o=; b=Pof/aWlyUJaJhrJEHb9vjbhRx1 UoUmENNaINCiUuNh46EQiGGoM9eRMMXIjTHEEfgMWiN3vhgoPhdi6AjzaNnNj8kZfiay+VpGziWq8 LEbS4D8/FV0ZBmQkMckHjWV1B+jjlJHsBQM3dPdf9fpE3mOktkc/wt6lJdw600z+eCGJ9zcBurRrW PyYoLMeWKd1tePgJxyiGU/Ok4ky9NKY36pZGXEqgKlAlehc0L1GxeYmSkEBDEc2K5pNaJuMlkSEgR VNNPG74hTdUvC69IVywnSvbvbFLgrQRjpJIlzoe8auFOIWBWF10vFKQIQz+HdOyq5xFWgLsLj4Rbp xTvWHz9Q==; X-CudaMail-Envelope-Sender: stephen@that.guru From: Stephen Finucane To: dev@openvswitch.org X-CudaMail-MID: CM-V1-1017049233 X-CudaMail-DTE: 101816 X-CudaMail-Originating-IP: 23.83.214.29 Date: Tue, 18 Oct 2016 21:03:36 +0100 X-ASG-Orig-Subj: [##CM-V1-1017049233##][PATCH 06/15] doc: Convert REPORTING-BUGS to rST Message-Id: <1476821025-4915-7-git-send-email-stephen@that.guru> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1476821025-4915-1-git-send-email-stephen@that.guru> References: <1476821025-4915-1-git-send-email-stephen@that.guru> X-OutGoing-Spam-Status: No, score=-9.2 X-AuthUser: stephen@that.guru X-GBUdb-Analysis: 0, 23.83.214.29, Ugly c=0.327499 p=-0.0833333 Source Normal X-MessageSniffer-Rules: 0-0-0-14316-c X-Barracuda-Connect: UNKNOWN[192.168.14.2] X-Barracuda-Start-Time: 1476821175 X-Barracuda-Encrypted: DHE-RSA-AES256-SHA X-Barracuda-URL: https://web.cudamail.com:443/cgi-mod/mark.cgi X-Virus-Scanned: by bsmtpd at cudamail.com X-Barracuda-BRTS-Status: 1 X-Barracuda-Spam-Score: 1.10 X-Barracuda-Spam-Status: No, SCORE=1.10 using global scores of TAG_LEVEL=3.5 QUARANTINE_LEVEL=1000.0 KILL_LEVEL=4.0 tests=BSF_SC0_MV0713, BSF_SC5_MJ1963, DKIM_SIGNED, RDNS_NONE X-Barracuda-Spam-Report: Code version 3.2, rules version 3.2.3.33831 Rule breakdown below pts rule name description ---- ---------------------- -------------------------------------------------- 0.00 DKIM_SIGNED Domain Keys Identified Mail: message has a signature 0.10 RDNS_NONE Delivered to trusted network by a host with no rDNS 0.50 BSF_SC0_MV0713 Custom rule MV0713 0.50 BSF_SC5_MJ1963 Custom Rule MJ1963 Subject: [ovs-dev] [PATCH 06/15] doc: Convert REPORTING-BUGS to rST X-BeenThere: dev@openvswitch.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: dev-bounces@openvswitch.org Sender: "dev" Signed-off-by: Stephen Finucane --- Makefile.am | 2 +- REPORTING-BUGS.md | 58 ------------------------------------------- REPORTING-BUGS.rst | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ SECURITY.md | 2 +- 4 files changed, 75 insertions(+), 60 deletions(-) delete mode 100644 REPORTING-BUGS.md create mode 100644 REPORTING-BUGS.rst diff --git a/Makefile.am b/Makefile.am index 6117ca8..dc92b71 100644 --- a/Makefile.am +++ b/Makefile.am @@ -92,7 +92,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 c046af9..0000000 --- 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 ` - for each `` 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 0000000..73e0df3 --- /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 `` for each + ```` 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 6247153..4cc4ed6 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.