* [spp] [PATCH 1/1] docs: add bug report chapter
@ 2020-06-25 8:01 x-fn-spp-ml
2020-06-30 6:51 ` Itsuro ODA
` (3 more replies)
0 siblings, 4 replies; 6+ messages in thread
From: x-fn-spp-ml @ 2020-06-25 8:01 UTC (permalink / raw)
To: spp, yasufum.o
From: Hideyuki Yamashita <yamashita.hideyuki@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@ntt-tx.co.jp>
Signed-off-by: Naoki Takada <ntakada14@gmail.com>
---
CONTRIBUTING.txt | 6 ++++++
docs/guides/bug_report.rst | 18 ++++++++++++++++++
docs/guides/index.rst | 1 +
3 files changed, 25 insertions(+)
create mode 100644 docs/guides/bug_report.rst
diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt
index 957b7fb..3b24738 100644
--- a/CONTRIBUTING.txt
+++ b/CONTRIBUTING.txt
@@ -45,6 +45,12 @@ Coding Guidelines
* C code should follow the DPDK coding standards.
* Python code should follow PEP8.
+Bug report
+----------
+
+How to issue bug is described in "Bug report" chapter
+in the RST document.
+
Maintainer
----------
diff --git a/docs/guides/bug_report.rst b/docs/guides/bug_report.rst
new file mode 100644
index 0000000..e9064e3
--- /dev/null
+++ b/docs/guides/bug_report.rst
@@ -0,0 +1,18 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2020 Nippon Telegraph and Telephone Corporation
+
+Bug Report
+==========
+
+SPP is 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
\ No newline at end of file
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
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [spp] [PATCH 1/1] docs: add bug report chapter
2020-06-25 8:01 [spp] [PATCH 1/1] docs: add bug report chapter x-fn-spp-ml
@ 2020-06-30 6:51 ` Itsuro ODA
2020-07-01 14:46 ` Yasufumi Ogawa
` (2 subsequent siblings)
3 siblings, 0 replies; 6+ messages in thread
From: Itsuro ODA @ 2020-06-30 6:51 UTC (permalink / raw)
To: spp, yasufum.o
Reviewed-by: Itsuro Oda <oda@valinux.co.jp>
--
Itsuro ODA <oda@valinux.co.jp>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [spp] [PATCH 1/1] docs: add bug report chapter
2020-06-25 8:01 [spp] [PATCH 1/1] docs: add bug report chapter x-fn-spp-ml
2020-06-30 6:51 ` Itsuro ODA
@ 2020-07-01 14:46 ` Yasufumi Ogawa
2020-07-14 5:00 ` [spp] [PATCH v2 0/1] " x-fn-spp-ml
2020-07-14 5:00 ` [spp] [PATCH v2 1/1] docs: " x-fn-spp-ml
3 siblings, 0 replies; 6+ messages in thread
From: Yasufumi Ogawa @ 2020-07-01 14:46 UTC (permalink / raw)
To: x-fn-spp-ml; +Cc: spp
> From: Hideyuki Yamashita <yamashita.hideyuki@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@ntt-tx.co.jp>
> Signed-off-by: Naoki Takada <ntakada14@gmail.com>
> ---
> CONTRIBUTING.txt | 6 ++++++
> docs/guides/bug_report.rst | 18 ++++++++++++++++++
> docs/guides/index.rst | 1 +
> 3 files changed, 25 insertions(+)
> create mode 100644 docs/guides/bug_report.rst
>
> diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt
> index 957b7fb..3b24738 100644
> --- a/CONTRIBUTING.txt
> +++ b/CONTRIBUTING.txt
> @@ -45,6 +45,12 @@ Coding Guidelines
> * C code should follow the DPDK coding standards.
> * Python code should follow PEP8.
>
> +Bug report
> +----------
> +
> +How to issue bug is described in "Bug report" chapter
Please revise
- "issue bug" -> "issue a bug"
- Make "Bug report" to be a link to the chapter
> +in the RST document.
No need to say "RST" because compiled document is not rst format but html.
> +
> Maintainer
> ----------
>
> diff --git a/docs/guides/bug_report.rst b/docs/guides/bug_report.rst
> new file mode 100644
> index 0000000..e9064e3
> --- /dev/null
> +++ b/docs/guides/bug_report.rst
> @@ -0,0 +1,18 @@
> +.. SPDX-License-Identifier: BSD-3-Clause
> + Copyright(c) 2020 Nippon Telegraph and Telephone Corporation
> +
> +Bug Report
> +==========
> +
> +SPP is hosted project of DPDK.
"SPP is a hosted ..."
> +DPDK uses Bugzilla as its bug tracking system.
> +
This empty line is not needed.
> +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.
> +
This empty line is not needed.
> +You can view open SPP related bugs in the following link:
> +
> +https://bugs.dpdk.org/buglist.cgi?bug_status=__open__&product=SPP
> \ No newline at end of file
I'm curious about this line. Did you edit this patch on windows possibly?
> 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.
>
^ permalink raw reply [flat|nested] 6+ messages in thread
* [spp] [PATCH v2 0/1] add bug report chapter
2020-06-25 8:01 [spp] [PATCH 1/1] docs: add bug report chapter x-fn-spp-ml
2020-06-30 6:51 ` Itsuro ODA
2020-07-01 14:46 ` Yasufumi Ogawa
@ 2020-07-14 5:00 ` x-fn-spp-ml
2020-07-14 15:33 ` Yasufumi Ogawa
2020-07-14 5:00 ` [spp] [PATCH v2 1/1] docs: " x-fn-spp-ml
3 siblings, 1 reply; 6+ messages in thread
From: x-fn-spp-ml @ 2020-07-14 5:00 UTC (permalink / raw)
To: spp, yasufum.o
From: Hideyuki Yamashita <yamashita.hideyuki@ntt-tx.co.jp>
v2:
* remove unnecessary white space, modify typos.
Hideyuki Yamashita (1):
docs: add bug report chapter
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
--
2.17.1
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [spp] [PATCH v2 0/1] add bug report chapter
2020-07-14 5:00 ` [spp] [PATCH v2 0/1] " x-fn-spp-ml
@ 2020-07-14 15:33 ` Yasufumi Ogawa
0 siblings, 0 replies; 6+ messages in thread
From: Yasufumi Ogawa @ 2020-07-14 15:33 UTC (permalink / raw)
To: x-fn-spp-ml; +Cc: spp
> From: Hideyuki Yamashita <yamashita.hideyuki@ntt-tx.co.jp>
>
> v2:
> * remove unnecessary white space, modify typos.
>
> Hideyuki Yamashita (1):
> docs: add bug report chapter
Applied, thanks!
>
> 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
>
^ permalink raw reply [flat|nested] 6+ messages in thread
* [spp] [PATCH v2 1/1] docs: add bug report chapter
2020-06-25 8:01 [spp] [PATCH 1/1] docs: add bug report chapter x-fn-spp-ml
` (2 preceding siblings ...)
2020-07-14 5:00 ` [spp] [PATCH v2 0/1] " x-fn-spp-ml
@ 2020-07-14 5:00 ` x-fn-spp-ml
3 siblings, 0 replies; 6+ messages in thread
From: x-fn-spp-ml @ 2020-07-14 5:00 UTC (permalink / raw)
To: spp, yasufum.o
From: Hideyuki Yamashita <yamashita.hideyuki@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@ntt-tx.co.jp>
Signed-off-by: Naoki Takada <ntakada14@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
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2020-07-14 15:33 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-06-25 8:01 [spp] [PATCH 1/1] docs: add bug report chapter x-fn-spp-ml
2020-06-30 6:51 ` Itsuro ODA
2020-07-01 14:46 ` Yasufumi Ogawa
2020-07-14 5:00 ` [spp] [PATCH v2 0/1] " x-fn-spp-ml
2020-07-14 15:33 ` Yasufumi Ogawa
2020-07-14 5:00 ` [spp] [PATCH v2 1/1] docs: " x-fn-spp-ml
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).