[dpdk-dev] doc: remove wrong document description

Message ID 68dc5388c54099ba26e9d0d1dd30e5fa6f9fbfc0.1480411543.git.baruch@tkos.co.il (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
checkpatch/checkpatch success coding style OK

Commit Message

Baruch Siach Nov. 29, 2016, 9:25 a.m. UTC
  The Programmer’s Guide intro is not the Release Notes.

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
 doc/guides/prog_guide/intro.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Baruch Siach Nov. 29, 2016, 10:54 a.m. UTC | #1
Hi John,

On Tue, Nov 29, 2016 at 09:54:58AM +0000, Mcnamara, John wrote:
> > -----Original Message-----
> > From: Baruch Siach [mailto:baruch@tkos.co.il]
> > Sent: Tuesday, November 29, 2016 9:26 AM
> > To: dev@dpdk.org
> > Cc: Mcnamara, John <john.mcnamara@intel.com>; Baruch Siach
> > <baruch@tkos.co.il>
> > Subject: [PATCH] doc: remove wrong document description
> > 
> > The Programmer’s Guide intro is not the Release Notes.
> > 
> > Signed-off-by: Baruch Siach <baruch@tkos.co.il>
> 
> Thanks for the fix.
> 
> I would be in favour of removing the entire "Documentation Roadmap" and 
> "Related Publications" sections. I meant to do that in the past.
> 
> As for this patch:
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Thanks. For some reason patchwork didn't get your ack.

baruch
  
John McNamara Nov. 29, 2016, 10:58 a.m. UTC | #2
> -----Original Message-----

> From: Baruch Siach [mailto:baruch@tkos.co.il]

> Sent: Tuesday, November 29, 2016 10:54 AM

> To: Mcnamara, John <john.mcnamara@intel.com>

> Cc: dev@dpdk.org

> Subject: Re: [PATCH] doc: remove wrong document description

> 

> Hi John,

> 

> On Tue, Nov 29, 2016 at 09:54:58AM +0000, Mcnamara, John wrote:

> > > -----Original Message-----

> > > From: Baruch Siach [mailto:baruch@tkos.co.il]

> > > Sent: Tuesday, November 29, 2016 9:26 AM

> > > To: dev@dpdk.org

> > > Cc: Mcnamara, John <john.mcnamara@intel.com>; Baruch Siach

> > > <baruch@tkos.co.il>

> > > Subject: [PATCH] doc: remove wrong document description

> > >

> > > The Programmer’s Guide intro is not the Release Notes.

> > >

> > > Signed-off-by: Baruch Siach <baruch@tkos.co.il>

> >

> > Thanks for the fix.

> >

> > I would be in favour of removing the entire "Documentation Roadmap"

> > and "Related Publications" sections. I meant to do that in the past.

> >

> > As for this patch:

> >

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

> 

> Thanks. For some reason patchwork didn't get your ack.



Strange. I worked for one I acked shortly afterwards.

I'll try once more.

John
  
John McNamara Nov. 29, 2016, 10:59 a.m. UTC | #3
> -----Original Message-----

> From: Baruch Siach [mailto:baruch@tkos.co.il]

> Sent: Tuesday, November 29, 2016 9:26 AM

> To: dev@dpdk.org

> Cc: Mcnamara, John <john.mcnamara@intel.com>; Baruch Siach

> <baruch@tkos.co.il>

> Subject: [PATCH] doc: remove wrong document description

> 

> The Programmer’s Guide intro is not the Release Notes.

> 

> Signed-off-by: Baruch Siach <baruch@tkos.co.il>



Acked-by: John McNamara <john.mcnamara@intel.com>
  
Thomas Monjalon Nov. 29, 2016, 8:38 p.m. UTC | #4
2016-11-29 12:54, Baruch Siach:
> On Tue, Nov 29, 2016 at 09:54:58AM +0000, Mcnamara, John wrote:
> > Acked-by: John McNamara <john.mcnamara@intel.com>
> 
> Thanks. For some reason patchwork didn't get your ack.

That's because you are not registered to the mailing list so your email
was in a moderation queue while John sent his ack.
You should register to avoid moderation and such issues:
	http://dpdk.org/ml/listinfo/dev
  
Thomas Monjalon Dec. 6, 2016, 5:03 p.m. UTC | #5
> > The Programmer’s Guide intro is not the Release Notes.
> > 
> > Signed-off-by: Baruch Siach <baruch@tkos.co.il>
> 
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied (merged with 2 others), thanks
  

Patch

diff --git a/doc/guides/prog_guide/intro.rst b/doc/guides/prog_guide/intro.rst
index d6daab3763b4..9fe1f0c31f0e 100644
--- a/doc/guides/prog_guide/intro.rst
+++ b/doc/guides/prog_guide/intro.rst
@@ -44,7 +44,7 @@  Documentation Roadmap
 
 The following is a list of DPDK documents in the suggested reading order:
 
-*   **Release Notes** (this document): Provides release-specific information, including supported features,
+*   **Release Notes** : Provides release-specific information, including supported features,
     limitations, fixed issues, known issues and so on.
     Also, provides the answers to frequently asked questions in FAQ format.