[spp] [PATCH v2 1/1] docs: add bug report chapter
x-fn-spp-ml at ntt-tx.co.jp
x-fn-spp-ml at ntt-tx.co.jp
Tue Jul 14 07:00:50 CEST 2020
From: Hideyuki Yamashita <yamashita.hideyuki at ntt-tx.co.jp>
This patch adds how to issue bug using Bugzilla in RST document.
Also reference is addded from "CONTRIBUTING.txt".
Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki at ntt-tx.co.jp>
Signed-off-by: Naoki Takada <ntakada14 at gmail.com>
---
CONTRIBUTING.txt | 7 +++++++
docs/guides/bug_report.rst | 16 ++++++++++++++++
docs/guides/index.rst | 1 +
3 files changed, 24 insertions(+)
create mode 100644 docs/guides/bug_report.rst
diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt
index 957b7fb..0525ce0 100644
--- a/CONTRIBUTING.txt
+++ b/CONTRIBUTING.txt
@@ -45,6 +45,13 @@ Coding Guidelines
* C code should follow the DPDK coding standards.
* Python code should follow PEP8.
+Bug report
+----------
+
+How to issue a bug is described in "Bug report" chapter under the
+official document:
+https://doc.dpdk.org/spp/
+
Maintainer
----------
diff --git a/docs/guides/bug_report.rst b/docs/guides/bug_report.rst
new file mode 100644
index 0000000..e255553
--- /dev/null
+++ b/docs/guides/bug_report.rst
@@ -0,0 +1,16 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2020 Nippon Telegraph and Telephone Corporation
+
+Bug Report
+==========
+
+SPP is a hosted project of DPDK.
+DPDK uses Bugzilla as its bug tracking system.
+Users can issue SPP related bugs in the following link:
+
+https://bugs.dpdk.org/enter_bug.cgi?product=SPP
+
+Note that to issue new bug, you have to create account to the Bugzilla.
+You can view open SPP related bugs in the following link:
+
+https://bugs.dpdk.org/buglist.cgi?bug_status=__open__&product=SPP
diff --git a/docs/guides/index.rst b/docs/guides/index.rst
index 70ec4a6..3ea80ef 100644
--- a/docs/guides/index.rst
+++ b/docs/guides/index.rst
@@ -15,6 +15,7 @@ SPP documentation
commands/index
tools/index
api_ref/index
+ bug_report
This documentation is the latest tagged version, but some of the latest
developing features might be not included.
--
2.17.1
More information about the spp
mailing list