Re: [spp] [PATCH 1/1] docs: add bug report chapter

[Yasufumi Ogawa <yasufum.o@gmail.com>]

> 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.
>