[PATCH] examples: fix unusual-interpreter

[PATCH] examples: fix unusual-interpreter

[Christian Ehrhardt]

Due to regular lintian checks in Debian packaging it surfaced that these
two scripts had a space in their #! statement which renders it to be
human, but not shell readable.

Fixes: 8673a3e8 ("examples/ip_pipeline: add config diagram generator")
Fixes: fa667b46 ("examples/ip_pipeline: add core mappings script")

Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
---
 examples/ip_pipeline/config/diagram-generator.py        | 2 +-
 examples/ip_pipeline/config/pipeline-to-core-mapping.py | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/examples/ip_pipeline/config/diagram-generator.py b/examples/ip_pipeline/config/diagram-generator.py
index f20cbcb..7b1f8d6 100755
--- a/examples/ip_pipeline/config/diagram-generator.py
+++ b/examples/ip_pipeline/config/diagram-generator.py
@@ -1,4 +1,4 @@
-#! /usr/bin/python2
+#!/usr/bin/python2
 
 #   BSD LICENSE
 #
diff --git a/examples/ip_pipeline/config/pipeline-to-core-mapping.py b/examples/ip_pipeline/config/pipeline-to-core-mapping.py
index 37b131c..5ffc632 100755
--- a/examples/ip_pipeline/config/pipeline-to-core-mapping.py
+++ b/examples/ip_pipeline/config/pipeline-to-core-mapping.py
@@ -1,4 +1,4 @@
-#! /usr/bin/python2
+#!/usr/bin/python2
 
 #   BSD LICENSE
 #
-- 
2.7.4

Re: [PATCH] examples: fix unusual-interpreter

[Thomas Monjalon]

2016-08-01 14:28, Christian Ehrhardt:
> Due to regular lintian checks in Debian packaging it surfaced that these
> two scripts had a space in their #! statement which renders it to be
> human, but not shell readable.
[...]
> -#! /usr/bin/python2
> +#!/usr/bin/python2

I think we can have a space in the shebang (it works with shells I know).
But maybe lintian do not like it (and it is a sufficient reason to accept
this trivial patch).

However, a better fix would be to run something else than python2,
like /usr/bin/env python.

Some other python scripts in tools dir may be fixed.

Re: [PATCH] examples: fix unusual-interpreter

[Christian Ehrhardt]

Hi Thomas,
I agree on both changes you suggested, but not being the scripts author I
wanted to change as few as possible.
Also thanks for taking it into consideration even if just for lintian :-)

If acceptable to you I'd ask to accept this as-is and consider the patch a
head-up for all script owners to change their headers.



Christian Ehrhardt
Software Engineer, Ubuntu Server
Canonical Ltd

On Mon, Aug 1, 2016 at 2:50 PM, Thomas Monjalon <thomas.monjalon@6wind.com>
wrote:

> 2016-08-01 14:28, Christian Ehrhardt:
> > Due to regular lintian checks in Debian packaging it surfaced that these
> > two scripts had a space in their #! statement which renders it to be
> > human, but not shell readable.
> [...]
> > -#! /usr/bin/python2
> > +#!/usr/bin/python2
>
> I think we can have a space in the shebang (it works with shells I know).
> But maybe lintian do not like it (and it is a sufficient reason to accept
> this trivial patch).
>
> However, a better fix would be to run something else than python2,
> like /usr/bin/env python.
>
> Some other python scripts in tools dir may be fixed.
>

Re: [PATCH] examples: fix unusual-interpreter

[Thomas Monjalon]

2016-08-01 15:12, Christian Ehrhardt:
> On Mon, Aug 1, 2016 at 2:50 PM, Thomas Monjalon <thomas.monjalon@6wind.com>
> wrote:
> > 2016-08-01 14:28, Christian Ehrhardt:
> > > Due to regular lintian checks in Debian packaging it surfaced that these
> > > two scripts had a space in their #! statement which renders it to be
> > > human, but not shell readable.
> > [...]
> > > -#! /usr/bin/python2
> > > +#!/usr/bin/python2
> >
> > I think we can have a space in the shebang (it works with shells I know).
> > But maybe lintian do not like it (and it is a sufficient reason to accept
> > this trivial patch).
> >
> > However, a better fix would be to run something else than python2,
> > like /usr/bin/env python.
> >
> > Some other python scripts in tools dir may be fixed.
> 
> I agree on both changes you suggested, but not being the scripts author I
> wanted to change as few as possible.
> Also thanks for taking it into consideration even if just for lintian :-)
> 
> If acceptable to you I'd ask to accept this as-is and consider the patch a
> head-up for all script owners to change their headers.

We can remove the space in every scripts, at least.
Then we can wait a little for the opinion of the script authors to do
more changes.

PS: Please avoid top posting.

Re: [PATCH] examples: fix unusual-interpreter

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Thomas Monjalon
> Sent: Monday, August 1, 2016 2:26 PM
> To: Christian Ehrhardt <christian.ehrhardt@canonical.com>
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] examples: fix unusual-interpreter
> 
> 2016-08-01 15:12, Christian Ehrhardt:
> > On Mon, Aug 1, 2016 at 2:50 PM, Thomas Monjalon
> > <thomas.monjalon@6wind.com>
> > wrote:
> > > 2016-08-01 14:28, Christian Ehrhardt:
> > > > Due to regular lintian checks in Debian packaging it surfaced that
> > > > these two scripts had a space in their #! statement which renders
> > > > it to be human, but not shell readable.
> > > [...]
> > > > -#! /usr/bin/python2
> > > > +#!/usr/bin/python2
> > >
> > > I think we can have a space in the shebang (it works with shells I
> know).
> > > But maybe lintian do not like it (and it is a sufficient reason to
> > > accept this trivial patch).
> > >
> > > However, a better fix would be to run something else than python2,
> > > like /usr/bin/env python.
> > >
> > > Some other python scripts in tools dir may be fixed.
> >
> > I agree on both changes you suggested, but not being the scripts
> > author I wanted to change as few as possible.
> > Also thanks for taking it into consideration even if just for lintian
> > :-)
> >
> > If acceptable to you I'd ask to accept this as-is and consider the
> > patch a head-up for all script owners to change their headers.
> 
> We can remove the space in every scripts, at least.
> Then we can wait a little for the opinion of the script authors to do more
> changes.
> 

Hi,

The script is Python2/3 compatible so remove the space and change to /usr/bin/python or similar.

John

[PATCH v2] examples: fix unusual-interpreter

[Christian Ehrhardt]

*update in v2*
- use #!/usr/bin/env python as usually recommended and suggested in the
  discussion

Due to regular lintian checks in Debian packaging it surfaced that these
two scripts had a space in their #! statement which renders it to be
human, but not shell readable.

Fixes: 8673a3e8 ("examples/ip_pipeline: add config diagram generator")
Fixes: fa667b46 ("examples/ip_pipeline: add core mappings script")

Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
---
 examples/ip_pipeline/config/diagram-generator.py        | 2 +-
 examples/ip_pipeline/config/pipeline-to-core-mapping.py | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/examples/ip_pipeline/config/diagram-generator.py b/examples/ip_pipeline/config/diagram-generator.py
index f20cbcb..6b7170b 100755
--- a/examples/ip_pipeline/config/diagram-generator.py
+++ b/examples/ip_pipeline/config/diagram-generator.py
@@ -1,4 +1,4 @@
-#! /usr/bin/python2
+#!/usr/bin/env python
 
 #   BSD LICENSE
 #
diff --git a/examples/ip_pipeline/config/pipeline-to-core-mapping.py b/examples/ip_pipeline/config/pipeline-to-core-mapping.py
index 37b131c..c2050b8 100755
--- a/examples/ip_pipeline/config/pipeline-to-core-mapping.py
+++ b/examples/ip_pipeline/config/pipeline-to-core-mapping.py
@@ -1,4 +1,4 @@
-#! /usr/bin/python2
+#!/usr/bin/env python
 
 #   BSD LICENSE
 #
-- 
2.7.4

Re: [PATCH v2] examples: fix unusual-interpreter

[Dumitrescu, Cristian]

> -----Original Message-----
> From: Christian Ehrhardt [mailto:christian.ehrhardt@canonical.com]
> Sent: Tuesday, August 2, 2016 7:40 AM
> To: christian.ehrhardt@canonical.com; thomas.monjalon@6wind.com;
> Dumitrescu, Cristian <cristian.dumitrescu@intel.com>; dev@dpdk.org
> Subject: [PATCH v2] examples: fix unusual-interpreter
> 
> *update in v2*
> - use #!/usr/bin/env python as usually recommended and suggested in the
>   discussion
> 
> Due to regular lintian checks in Debian packaging it surfaced that these
> two scripts had a space in their #! statement which renders it to be
> human, but not shell readable.
> 
> Fixes: 8673a3e8 ("examples/ip_pipeline: add config diagram generator")
> Fixes: fa667b46 ("examples/ip_pipeline: add core mappings script")
> 
> Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
> ---
>  examples/ip_pipeline/config/diagram-generator.py        | 2 +-
>  examples/ip_pipeline/config/pipeline-to-core-mapping.py | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 

Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

Re: [PATCH v2] examples: fix unusual-interpreter

[Thomas Monjalon]

> > *update in v2*
> > - use #!/usr/bin/env python as usually recommended and suggested in the
> >   discussion
> > 
> > Due to regular lintian checks in Debian packaging it surfaced that these
> > two scripts had a space in their #! statement which renders it to be
> > human, but not shell readable.
> > 
> > Fixes: 8673a3e8 ("examples/ip_pipeline: add config diagram generator")
> > Fixes: fa667b46 ("examples/ip_pipeline: add core mappings script")
> > 
> > Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
> 
> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

Applied, thanks

Re: [PATCH] examples: fix unusual-interpreter

[Dumitrescu, Cristian]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Christian Ehrhardt
> Sent: Monday, August 1, 2016 1:29 PM
> To: christian.ehrhardt@canonical.com; dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] examples: fix unusual-interpreter
> 
> Due to regular lintian checks in Debian packaging it surfaced that these
> two scripts had a space in their #! statement which renders it to be
> human, but not shell readable.
> 
> Fixes: 8673a3e8 ("examples/ip_pipeline: add config diagram generator")
> Fixes: fa667b46 ("examples/ip_pipeline: add core mappings script")
> 
> Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
> ---

Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

Christian and Thomas, 

Looking at this email thread, if there is an even better more robust solution, please suggest. It would not hurt to document it in the coding guidelines for scripts.

Thanks,
Cristian