[PATCH] doc: fix required tools list layout

[PATCH] doc: fix required tools list layout

[Baruch Siach]

The Python requirement should appear in the bullet list.

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
 doc/guides/linux_gsg/sys_reqs.rst | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst
index 3d743421595a..621cc9ddaef6 100644
--- a/doc/guides/linux_gsg/sys_reqs.rst
+++ b/doc/guides/linux_gsg/sys_reqs.rst
@@ -84,9 +84,7 @@ Compilation of the DPDK
     x86_x32 ABI is currently supported with distribution packages only on Ubuntu
     higher than 13.10 or recent Debian distribution. The only supported  compiler is gcc 4.9+.
 
-.. note::
-
-    Python, version 2.6 or 2.7, to use various helper scripts included in the DPDK package.
+*   Python, version 2.6 or 2.7, to use various helper scripts included in the DPDK package.
 
 
 **Optional Tools:**
-- 
2.10.2

Re: [PATCH] doc: fix required tools list layout

[Mcnamara, John]

> -----Original Message-----
> From: Baruch Siach [mailto:baruch@tkos.co.il]
> Sent: Tuesday, December 13, 2016 10:04 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; David Marchand
> <david.marchand@6wind.com>; Baruch Siach <baruch@tkos.co.il>
> Subject: [PATCH] doc: fix required tools list layout
> 
> The Python requirement should appear in the bullet list.
> 
> Signed-off-by: Baruch Siach <baruch@tkos.co.il>
> ---
>  doc/guides/linux_gsg/sys_reqs.rst | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/doc/guides/linux_gsg/sys_reqs.rst
> b/doc/guides/linux_gsg/sys_reqs.rst
> index 3d743421595a..621cc9ddaef6 100644
> --- a/doc/guides/linux_gsg/sys_reqs.rst
> +++ b/doc/guides/linux_gsg/sys_reqs.rst
> @@ -84,9 +84,7 @@ Compilation of the DPDK
>      x86_x32 ABI is currently supported with distribution packages only on
> Ubuntu
>      higher than 13.10 or recent Debian distribution. The only supported
> compiler is gcc 4.9+.
> 
> -.. note::
> -
> -    Python, version 2.6 or 2.7, to use various helper scripts included in
> the DPDK package.
> +*   Python, version 2.6 or 2.7, to use various helper scripts included in
> the DPDK package.
> 

Hi Baruch,

In addition to this change the note on the previous item should be indented to the level of the bullet item. It is probably worth making that change at the same time.

Also, the Python version should probably say 2.7+ and 3.2+ if this patch is accepted: 

    http://dpdk.org/dev/patchwork/patch/17775/

However, since that change hasn't been acked/merged yet you can leave that part of your patch as it is and I'll fix the version numbers in the other patch.

John

Re: [PATCH] doc: fix required tools list layout

[Baruch Siach]

Hi John,

On Thu, Dec 15, 2016 at 03:09:32PM +0000, Mcnamara, John wrote:
> > -----Original Message-----
> > From: Baruch Siach [mailto:baruch at tkos.co.il]
> > Sent: Tuesday, December 13, 2016 10:04 AM
> > To: dev at dpdk.org
> > Cc: Mcnamara, John <john.mcnamara at intel.com>; David Marchand
> > <david.marchand at 6wind.com>; Baruch Siach <baruch at tkos.co.il>
> > Subject: [PATCH] doc: fix required tools list layout
> > 
> > The Python requirement should appear in the bullet list.
> > 
> > Signed-off-by: Baruch Siach <baruch at tkos.co.il>
> > ---
> >  doc/guides/linux_gsg/sys_reqs.rst | 4 +---
> >  1 file changed, 1 insertion(+), 3 deletions(-)
> > 
> > diff --git a/doc/guides/linux_gsg/sys_reqs.rst
> > b/doc/guides/linux_gsg/sys_reqs.rst
> > index 3d743421595a..621cc9ddaef6 100644
> > --- a/doc/guides/linux_gsg/sys_reqs.rst
> > +++ b/doc/guides/linux_gsg/sys_reqs.rst
> > @@ -84,9 +84,7 @@ Compilation of the DPDK
> >      x86_x32 ABI is currently supported with distribution packages only on
> > Ubuntu
> >      higher than 13.10 or recent Debian distribution. The only supported
> > compiler is gcc 4.9+.
> > 
> > -.. note::
> > -
> > -    Python, version 2.6 or 2.7, to use various helper scripts included in
> > the DPDK package.
> > +*   Python, version 2.6 or 2.7, to use various helper scripts included in
> > the DPDK package.
> 
> In addition to this change the note on the previous item should be indented 
> to the level of the bullet item. It is probably worth making that change at 
> the same time.

All items are equally aligned as far as I can see. The 32bit on 64bit 
requirement bullets are sub-items of the previous item. Am I missing anything?

> Also, the Python version should probably say 2.7+ and 3.2+ if this patch is 
> accepted: 
> 
>     http://dpdk.org/dev/patchwork/patch/17775/
> 
> However, since that change hasn't been acked/merged yet you can leave that 
> part of your patch as it is and I'll fix the version numbers in the other 
> patch.

Note that your updated patch[1] conflicts with this one.

[1] http://dpdk.org/dev/patchwork/patch/18152/

baruch

-- 
     http://baruch.siach.name/blog/                  ~. .~   Tk Open Systems
=}------------------------------------------------ooO--U--Ooo------------{=
   - baruch@tkos.co.il - tel: +972.52.368.4656, http://www.tkos.co.il -

Re: [PATCH] doc: fix required tools list layout

[Mcnamara, John]

> -----Original Message-----
> From: Baruch Siach [mailto:baruch@tkos.co.il]
> Sent: Sunday, December 18, 2016 7:11 PM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: fix required tools list layout
> 
> Hi John,
> 
> On Thu, Dec 15, 2016 at 03:09:32PM +0000, Mcnamara, John wrote:
> > > -----Original Message-----
> > > From: Baruch Siach [mailto:baruch at tkos.co.il]
> > > Sent: Tuesday, December 13, 2016 10:04 AM
> > > To: dev at dpdk.org
> > > Cc: Mcnamara, John <john.mcnamara at intel.com>; David Marchand
> > > <david.marchand at 6wind.com>; Baruch Siach <baruch at tkos.co.il>
> > > Subject: [PATCH] doc: fix required tools list layout
> > >
> > > The Python requirement should appear in the bullet list.
> > >
> > > Signed-off-by: Baruch Siach <baruch at tkos.co.il>
> > > ---
> > >  doc/guides/linux_gsg/sys_reqs.rst | 4 +---
> > >  1 file changed, 1 insertion(+), 3 deletions(-)
> > >
> > > diff --git a/doc/guides/linux_gsg/sys_reqs.rst
> > > b/doc/guides/linux_gsg/sys_reqs.rst
> > > index 3d743421595a..621cc9ddaef6 100644
> > > --- a/doc/guides/linux_gsg/sys_reqs.rst
> > > +++ b/doc/guides/linux_gsg/sys_reqs.rst
> > > @@ -84,9 +84,7 @@ Compilation of the DPDK
> > >      x86_x32 ABI is currently supported with distribution packages
> > > only on Ubuntu
> > >      higher than 13.10 or recent Debian distribution. The only
> > > supported compiler is gcc 4.9+.
> > >
> > > -.. note::
> > > -
> > > -    Python, version 2.6 or 2.7, to use various helper scripts
> included in
> > > the DPDK package.
> > > +*   Python, version 2.6 or 2.7, to use various helper scripts
> included in
> > > the DPDK package.
> >
> > In addition to this change the note on the previous item should be
> > indented to the level of the bullet item. It is probably worth making
> > that change at the same time.
> 
> All items are equally aligned as far as I can see. The 32bit on 64bit
> requirement bullets are sub-items of the previous item. Am I missing
> anything?

Hi Baruch,

The note should be indented to the level of the first level bullet item text rather
than the margin since it is a note on that particular item and not a general note.
Like this:

    *   Additional packages required for 32-bit compilation on 64-bit systems are:

        * glibc.i686, libgcc.i686, libstdc++.i686 and glibc-devel.i686 for Intel i686/x86_64;

        * glibc.ppc64, libgcc.ppc64, libstdc++.ppc64 and glibc-devel.ppc64 for IBM ppc_64;

        .. note::

           x86_x32 ABI is currently supported with distribution packages only on Ubuntu
           higher than 13.10 or recent Debian distribution. The only supported  compiler is gcc 4.9+.

If you generate the html before and after you will see the difference.

> 
> > Also, the Python version should probably say 2.7+ and 3.2+ if this
> > patch is
> > accepted:
> >
> >     http://dpdk.org/dev/patchwork/patch/17775/
> >
> > However, since that change hasn't been acked/merged yet you can leave
> > that part of your patch as it is and I'll fix the version numbers in
> > the other patch.
> 
> Note that your updated patch[1] conflicts with this one.
> 

Yes. :-)

It also conflicts with Thomas' patch to move the directories. I'll rebase based
on whatever order the patches are applied in.

John