From patchwork Mon Sep 19 15:56:25 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Christoph Hellwig X-Patchwork-Id: 9339813 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 59F8C6077A for ; Mon, 19 Sep 2016 15:56:47 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 4C222294D6 for ; Mon, 19 Sep 2016 15:56:47 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 412B829523; Mon, 19 Sep 2016 15:56:47 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 43D23294D6 for ; Mon, 19 Sep 2016 15:56:43 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751866AbcISP4m (ORCPT ); Mon, 19 Sep 2016 11:56:42 -0400 Received: from bombadil.infradead.org ([198.137.202.9]:52820 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750940AbcISP4m (ORCPT ); Mon, 19 Sep 2016 11:56:42 -0400 Received: from [4.28.11.153] (helo=localhost) by bombadil.infradead.org with esmtpsa (Exim 4.85_2 #1 (Red Hat Linux)) id 1bm0vx-0004xQ-83; Mon, 19 Sep 2016 15:56:41 +0000 From: Christoph Hellwig To: jgunthorpe@obsidianresearch.com Cc: linux-rdma@vger.kernel.org Subject: [PATCH 1/9] add reporting bugs and submitting patches sections to README.md Date: Mon, 19 Sep 2016 08:56:25 -0700 Message-Id: <1474300593-31922-2-git-send-email-hch@lst.de> X-Mailer: git-send-email 2.1.4 In-Reply-To: <1474300593-31922-1-git-send-email-hch@lst.de> References: <1474300593-31922-1-git-send-email-hch@lst.de> X-SRS-Rewrite: SMTP reverse-path rewritten from by bombadil.infradead.org. See http://www.infradead.org/rpr.html Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Based on the wording from the libibverbs and srp_daemon README files. Signed-off-by: Christoph Hellwig --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 26f44c1..4cf1eed 100644 --- a/README.md +++ b/README.md @@ -95,3 +95,31 @@ $ install -m755 ninja /usr/local/bin/ninja ``` Use the 'cmake3' program in place of `cmake` in the above instructions. + +# Reporting bugs + +Bugs should be reported to the mailing list +In your bug report, please include: + + * Information about your system: + - Linux distribution and version + - Linux kernel and version + - InfiniBand hardware and firmware version + - ... any other relevant information + + * How to reproduce the bug. + + * If the bug is a crash, the exact output printed out when the crash + occurred, including any kernel messages produced. + +# Submitting patches + +Patches should also be submitted to the +mailing list. Please use unified diff form (the -u option to GNU diff), +and include a good description of what your patch does and why it should +be applied. If your patch fixes a bug, please make sure to describe the +bug and how your fix works. + +Make sure that your contribution can be licensed under the same +license as the original code you are patching, and that you have all +necessary permissions to release your work.