diff mbox

[dpdk-dev] doc: fix DPAA2 guide build warning

Message ID 1490608518-27315-1-git-send-email-shreyansh.jain@nxp.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Shreyansh Jain March 27, 2017, 9:55 a.m. UTC 
  Fixes: 17a4c3c16f5c ("doc: add DPAA2 NIC details")

Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
---
 doc/guides/nics/dpaa2.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

Comments

Ferruh Yigit March 27, 2017, 9:57 a.m. UTC | #1 
On 3/27/2017 10:57 AM, Shreyansh Jain wrote:
> On Monday 27 March 2017 03:25 PM, Shreyansh Jain wrote:
>> Fixes: 17a4c3c16f5c ("doc: add DPAA2 NIC details")
>>
>> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
>> ---
>>  doc/guides/nics/dpaa2.rst | 3 +--
>>  1 file changed, 1 insertion(+), 2 deletions(-)
>>
>> diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst
>> index 7d7a6c5..46225b6 100644
>> --- a/doc/guides/nics/dpaa2.rst
>> +++ b/doc/guides/nics/dpaa2.rst
>> @@ -441,8 +441,7 @@ compatible board:
>>
>>  1. **ARM 64 Tool Chain**
>>
>> -   For example, the *aarch64* Linaro Toolchain, which can be obtained from
>> -   `here <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
>> +   For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
>>
>>  2. **Linux Kernel**
>>
>>
> 
> I am not sure how to specific in patch that it applies on dpdk-net-next
> in response to [1].

I don't know either :), but thanks for letting know, I will check it.

> 
> [1] http://dpdk.org/ml/archives/dev/2017-March/061335.html
>
Shreyansh Jain March 27, 2017, 9:57 a.m. UTC | #2 
On Monday 27 March 2017 03:25 PM, Shreyansh Jain wrote:
> Fixes: 17a4c3c16f5c ("doc: add DPAA2 NIC details")
>
> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
> ---
>  doc/guides/nics/dpaa2.rst | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst
> index 7d7a6c5..46225b6 100644
> --- a/doc/guides/nics/dpaa2.rst
> +++ b/doc/guides/nics/dpaa2.rst
> @@ -441,8 +441,7 @@ compatible board:
>
>  1. **ARM 64 Tool Chain**
>
> -   For example, the *aarch64* Linaro Toolchain, which can be obtained from
> -   `here <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
> +   For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
>
>  2. **Linux Kernel**
>
>

I am not sure how to specific in patch that it applies on dpdk-net-next
in response to [1].

[1] http://dpdk.org/ml/archives/dev/2017-March/061335.html
John McNamara March 27, 2017, 10:16 a.m. UTC | #3 
> -----Original Message-----
> From: Shreyansh Jain [mailto:shreyansh.jain@nxp.com]
> Sent: Monday, March 27, 2017 10:55 AM
> To: Yigit, Ferruh <ferruh.yigit@intel.com>
> Cc: hemant.agrawal@nxp.com; dev@dpdk.org; Mcnamara, John
> <john.mcnamara@intel.com>; Shreyansh Jain <shreyansh.jain@nxp.com>
> Subject: [PATCH] doc: fix DPAA2 guide build warning
> 
> Fixes: 17a4c3c16f5c ("doc: add DPAA2 NIC details")
> 
> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
> ---
>  doc/guides/nics/dpaa2.rst | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst index
> 7d7a6c5..46225b6 100644
> --- a/doc/guides/nics/dpaa2.rst
> +++ b/doc/guides/nics/dpaa2.rst
> @@ -441,8 +441,7 @@ compatible board:
> 
>  1. **ARM 64 Tool Chain**
> 
> -   For example, the *aarch64* Linaro Toolchain, which can be obtained
> from
> -   `here <https://releases.linaro.org/components/toolchain/binaries/4.9-
> 2017.01/aarch64-linux-gnu>`_.
> +   For example, the `*aarch64* Linaro Toolchain
> <https://releases.linaro.org/components/toolchain/binaries/4.9-
> 2017.01/aarch64-linux-gnu>`_.
> 

What is the build warning?

Also, the existing version with the `here <link>`_ format is better since
it doesn't put a long url into the text. Probably it is better to fix that
if it that is the issue.
John McNamara March 27, 2017, 10:31 a.m. UTC | #4 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John
> Sent: Monday, March 27, 2017 11:16 AM
> To: Shreyansh Jain <shreyansh.jain@nxp.com>; Yigit, Ferruh
> <ferruh.yigit@intel.com>
> Cc: hemant.agrawal@nxp.com; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: fix DPAA2 guide build warning
> 
> 
> 
> > -----Original Message-----
> > From: Shreyansh Jain [mailto:shreyansh.jain@nxp.com]
> > Sent: Monday, March 27, 2017 10:55 AM
> > To: Yigit, Ferruh <ferruh.yigit@intel.com>
> > Cc: hemant.agrawal@nxp.com; dev@dpdk.org; Mcnamara, John
> > <john.mcnamara@intel.com>; Shreyansh Jain <shreyansh.jain@nxp.com>
> > Subject: [PATCH] doc: fix DPAA2 guide build warning
> >
> > Fixes: 17a4c3c16f5c ("doc: add DPAA2 NIC details")
> >
> > Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
> > ---
> >  doc/guides/nics/dpaa2.rst | 3 +--
> >  1 file changed, 1 insertion(+), 2 deletions(-)
> >
> > diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst
> > index
> > 7d7a6c5..46225b6 100644
> > --- a/doc/guides/nics/dpaa2.rst
> > +++ b/doc/guides/nics/dpaa2.rst
> > @@ -441,8 +441,7 @@ compatible board:
> >
> >  1. **ARM 64 Tool Chain**
> >
> > -   For example, the *aarch64* Linaro Toolchain, which can be obtained
> > from
> > -   `here
> <https://releases.linaro.org/components/toolchain/binaries/4.9-
> > 2017.01/aarch64-linux-gnu>`_.
> > +   For example, the `*aarch64* Linaro Toolchain
> > <https://releases.linaro.org/components/toolchain/binaries/4.9-
> > 2017.01/aarch64-linux-gnu>`_.
> >
> 
> What is the build warning?
> 
> Also, the existing version with the `here <link>`_ format is better since
> it doesn't put a long url into the text. Probably it is better to fix that
> if it that is the issue.
> 

Whoops, sorry. I misread the patch. I see that you are still using `here <link>`_
so disregard that comment.

I would still be good to see the build issue though.
Shreyansh Jain March 27, 2017, 10:45 a.m. UTC | #5 
On Monday 27 March 2017 03:46 PM, Mcnamara, John wrote:
>
>
>> -----Original Message-----
>> From: Shreyansh Jain [mailto:shreyansh.jain@nxp.com]
>> Sent: Monday, March 27, 2017 10:55 AM
>> To: Yigit, Ferruh <ferruh.yigit@intel.com>
>> Cc: hemant.agrawal@nxp.com; dev@dpdk.org; Mcnamara, John
>> <john.mcnamara@intel.com>; Shreyansh Jain <shreyansh.jain@nxp.com>
>> Subject: [PATCH] doc: fix DPAA2 guide build warning
>>
>> Fixes: 17a4c3c16f5c ("doc: add DPAA2 NIC details")
>>
>> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
>> ---
>>  doc/guides/nics/dpaa2.rst | 3 +--
>>  1 file changed, 1 insertion(+), 2 deletions(-)
>>
>> diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst index
>> 7d7a6c5..46225b6 100644
>> --- a/doc/guides/nics/dpaa2.rst
>> +++ b/doc/guides/nics/dpaa2.rst
>> @@ -441,8 +441,7 @@ compatible board:
>>
>>  1. **ARM 64 Tool Chain**
>>
>> -   For example, the *aarch64* Linaro Toolchain, which can be obtained
>> from
>> -   `here <https://releases.linaro.org/components/toolchain/binaries/4.9-
>> 2017.01/aarch64-linux-gnu>`_.
>> +   For example, the `*aarch64* Linaro Toolchain
>> <https://releases.linaro.org/components/toolchain/binaries/4.9-
>> 2017.01/aarch64-linux-gnu>`_.
>>
>
> What is the build warning?
>
> Also, the existing version with the `here <link>`_ format is better since
> it doesn't put a long url into the text. Probably it is better to fix that
> if it that is the issue.

The doc has two 'here ...' text references. As soon as I remove one of
them, the warning (WARNING: Duplicate explicit target name: "here") is
generated.

I am not sure of the reason so I resorted to replacing one of the
'here..' links.
Shreyansh Jain March 27, 2017, 10:54 a.m. UTC | #6 
On Monday 27 March 2017 04:01 PM, Mcnamara, John wrote:
>
>
>> -----Original Message-----
>> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John
>> Sent: Monday, March 27, 2017 11:16 AM
>> To: Shreyansh Jain <shreyansh.jain@nxp.com>; Yigit, Ferruh
>> <ferruh.yigit@intel.com>
>> Cc: hemant.agrawal@nxp.com; dev@dpdk.org
>> Subject: Re: [dpdk-dev] [PATCH] doc: fix DPAA2 guide build warning
>>
>>
>>
>>> -----Original Message-----
>>> From: Shreyansh Jain [mailto:shreyansh.jain@nxp.com]
>>> Sent: Monday, March 27, 2017 10:55 AM
>>> To: Yigit, Ferruh <ferruh.yigit@intel.com>
>>> Cc: hemant.agrawal@nxp.com; dev@dpdk.org; Mcnamara, John
>>> <john.mcnamara@intel.com>; Shreyansh Jain <shreyansh.jain@nxp.com>
>>> Subject: [PATCH] doc: fix DPAA2 guide build warning
>>>
>>> Fixes: 17a4c3c16f5c ("doc: add DPAA2 NIC details")
>>>
>>> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
>>> ---
>>>  doc/guides/nics/dpaa2.rst | 3 +--
>>>  1 file changed, 1 insertion(+), 2 deletions(-)
>>>
>>> diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst
>>> index
>>> 7d7a6c5..46225b6 100644
>>> --- a/doc/guides/nics/dpaa2.rst
>>> +++ b/doc/guides/nics/dpaa2.rst
>>> @@ -441,8 +441,7 @@ compatible board:
>>>
>>>  1. **ARM 64 Tool Chain**
>>>
>>> -   For example, the *aarch64* Linaro Toolchain, which can be obtained
>>> from
>>> -   `here
>> <https://releases.linaro.org/components/toolchain/binaries/4.9-
>>> 2017.01/aarch64-linux-gnu>`_.
>>> +   For example, the `*aarch64* Linaro Toolchain
>>> <https://releases.linaro.org/components/toolchain/binaries/4.9-
>>> 2017.01/aarch64-linux-gnu>`_.
>>>
>>
>> What is the build warning?
>>
>> Also, the existing version with the `here <link>`_ format is better since
>> it doesn't put a long url into the text. Probably it is better to fix that
>> if it that is the issue.
>>
>
> Whoops, sorry. I misread the patch. I see that you are still using `here <link>`_
> so disregard that comment.

I think there is some confusion. I have removed the string "here" and 
replaced that with another running text having the original link.

>
> I would still be good to see the build issue though.

The warning being shown on non-patched dpaa2.rst is:

--->8---
sphinx processing guides-html...
/home/shreyansh/build/DPDK/06_dpdk/doc/guides/nics/dpaa2.rst:32: 
WARNING: Duplicate explicit target name: "here".
--->8--

-
Shreyansh
Ferruh Yigit March 27, 2017, 11:12 a.m. UTC | #7 
On 3/27/2017 10:57 AM, Ferruh Yigit wrote:
> On 3/27/2017 10:57 AM, Shreyansh Jain wrote:
>> On Monday 27 March 2017 03:25 PM, Shreyansh Jain wrote:
>>> Fixes: 17a4c3c16f5c ("doc: add DPAA2 NIC details")
>>>
>>> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
>>> ---
>>>  doc/guides/nics/dpaa2.rst | 3 +--
>>>  1 file changed, 1 insertion(+), 2 deletions(-)
>>>
>>> diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst
>>> index 7d7a6c5..46225b6 100644
>>> --- a/doc/guides/nics/dpaa2.rst
>>> +++ b/doc/guides/nics/dpaa2.rst
>>> @@ -441,8 +441,7 @@ compatible board:
>>>
>>>  1. **ARM 64 Tool Chain**
>>>
>>> -   For example, the *aarch64* Linaro Toolchain, which can be obtained from
>>> -   `here <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
>>> +   For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
>>>
>>>  2. **Linux Kernel**
>>>
>>>
>>
>> I am not sure how to specific in patch that it applies on dpdk-net-next
>> in response to [1].
> 
> I don't know either :), but thanks for letting know, I will check it.

I confirm this fixes the documentation warning, patch squashed into
relevant commit (17a4c3c16f5c)

> 
>>
>> [1] http://dpdk.org/ml/archives/dev/2017-March/061335.html
>>
>
John McNamara March 27, 2017, 11:22 a.m. UTC | #8 
> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Monday, March 27, 2017 12:12 PM
> To: Shreyansh Jain <shreyansh.jain@nxp.com>
> Cc: hemant.agrawal@nxp.com; dev@dpdk.org; Mcnamara, John
> <john.mcnamara@intel.com>
> Subject: Re: [PATCH] doc: fix DPAA2 guide build warning
> 
> On 3/27/2017 10:57 AM, Ferruh Yigit wrote:
> > On 3/27/2017 10:57 AM, Shreyansh Jain wrote:
> >> On Monday 27 March 2017 03:25 PM, Shreyansh Jain wrote:
> >>> Fixes: 17a4c3c16f5c ("doc: add DPAA2 NIC details")
> >>>
> >>> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
> >>> ---
> >>>  doc/guides/nics/dpaa2.rst | 3 +--
> >>>  1 file changed, 1 insertion(+), 2 deletions(-)
> >>>
> >>> diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst
> >>> index 7d7a6c5..46225b6 100644
> >>> --- a/doc/guides/nics/dpaa2.rst
> >>> +++ b/doc/guides/nics/dpaa2.rst
> >>> @@ -441,8 +441,7 @@ compatible board:
> >>>
> >>>  1. **ARM 64 Tool Chain**
> >>>
> >>> -   For example, the *aarch64* Linaro Toolchain, which can be obtained
> from
> >>> -   `here
> <https://releases.linaro.org/components/toolchain/binaries/4.9-
> 2017.01/aarch64-linux-gnu>`_.
> >>> +   For example, the `*aarch64* Linaro Toolchain
> <https://releases.linaro.org/components/toolchain/binaries/4.9-
> 2017.01/aarch64-linux-gnu>`_.
> >>>
> >>>  2. **Linux Kernel**
> >>>
> >>>
> >>
> >> I am not sure how to specific in patch that it applies on
> >> dpdk-net-next in response to [1].
> >
> > I don't know either :), but thanks for letting know, I will check it.
> 
> I confirm this fixes the documentation warning, patch squashed into
> relevant commit (17a4c3c16f5c)
> 

In that case:

Acked-by: John McNamara <john.mcnamara@intel.com>
diff mbox

Patch

diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst
index 7d7a6c5..46225b6 100644
--- a/doc/guides/nics/dpaa2.rst
+++ b/doc/guides/nics/dpaa2.rst
@@ -441,8 +441,7 @@  compatible board:
 
 1. **ARM 64 Tool Chain**
 
-   For example, the *aarch64* Linaro Toolchain, which can be obtained from
-   `here <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
+   For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
 
 2. **Linux Kernel**