diff mbox

package/linux-tools: change method for including linux-tool sub-makefiles

Message ID 20170718181137.23347-1-mmayer@broadcom.com
State Accepted
Headers show

Commit Message

Markus Mayer July 18, 2017, 6:11 p.m. UTC
Make inclusion ordering of all linux-tool-*.mk sub-makefiles explicit
instead of relying on alphabetical sort order. This is done by
renaming the Linux tools sub-makefiles to the format linux-tool-*.mk.in.
This causes the top-level Makefile to ignore the Linux tools
sub-makefiles.

Until now, the main Makefile included all linux-tool-*.mk files, as
well as linux-tools.mk, and it relied on alphabetical sorting to
include them in the proper order (linux-tool-*.mk before
linux-tools.mk).

Signed-off-by: Markus Mayer <mmayer@broadcom.com>
---

This patch is the result of the discussion that can be found at
http://lists.busybox.net/pipermail/buildroot/2017-July/thread.html#196876

 docs/manual/adding-packages-linux-kernel-spec-infra.txt  |  4 ++--
 ...{linux-tool-cpupower.mk => linux-tool-cpupower.mk.in} |  0
 .../{linux-tool-gpio.mk => linux-tool-gpio.mk.in}        |  0
 .../{linux-tool-iio.mk => linux-tool-iio.mk.in}          |  0
 .../{linux-tool-perf.mk => linux-tool-perf.mk.in}        |  0
 ...inux-tool-selftests.mk => linux-tool-selftests.mk.in} |  0
 package/linux-tools/linux-tools.mk                       | 16 +++++++---------
 7 files changed, 9 insertions(+), 11 deletions(-)
 rename package/linux-tools/{linux-tool-cpupower.mk => linux-tool-cpupower.mk.in} (100%)
 rename package/linux-tools/{linux-tool-gpio.mk => linux-tool-gpio.mk.in} (100%)
 rename package/linux-tools/{linux-tool-iio.mk => linux-tool-iio.mk.in} (100%)
 rename package/linux-tools/{linux-tool-perf.mk => linux-tool-perf.mk.in} (100%)
 rename package/linux-tools/{linux-tool-selftests.mk => linux-tool-selftests.mk.in} (100%)

Comments

Yann E. MORIN July 18, 2017, 7:06 p.m. UTC | #1
Markus, All,

On 2017-07-18 11:11 -0700, Markus Mayer spake thusly:
> Make inclusion ordering of all linux-tool-*.mk sub-makefiles explicit
> instead of relying on alphabetical sort order. This is done by
> renaming the Linux tools sub-makefiles to the format linux-tool-*.mk.in.
> This causes the top-level Makefile to ignore the Linux tools
> sub-makefiles.
> 
> Until now, the main Makefile included all linux-tool-*.mk files, as
> well as linux-tools.mk, and it relied on alphabetical sorting to
> include them in the proper order (linux-tool-*.mk before
> linux-tools.mk).
> 
> Signed-off-by: Markus Mayer <mmayer@broadcom.com>

Thank you for this new iteration.

I have a small comment, see below...

[--SNIP--]
> diff --git a/package/linux-tools/linux-tools.mk b/package/linux-tools/linux-tools.mk
> index 7fa8d19..2827ade 100644
> --- a/package/linux-tools/linux-tools.mk
> +++ b/package/linux-tools/linux-tools.mk
> @@ -10,15 +10,13 @@
>  #
>  # So, all tools refer to $(LINUX_DIR) instead of $(@D).
>  
> -# Note: we need individual tools .mk files to be included *before* this one
> -# to guarantee that each tool has a chance to register itself before we build
> -# the list of build and install hooks, below.
> -#
> -# This is currently guaranteed by the naming of each file:
> -# - they get included by the top-level Makefile, with $(sort $(wildcard ...))
> -# - make's $(sort) function will aways sort in the C locale
> -# - the files names correctly sort out in the C locale so that each tool's
> -#   .mk file is included before this one.
> +# Note: we need individual tools makefiles to be included *before* we build
> +# the list of build and install hooks below to guarantee that each tool has
> +# a chance to register itself. Therefore, the makefiles are named
> +# linux-tool-*.mk.in, so they won't be picked up by the top-level Makefile,
> +# but can be included here, guaranteeing proper ordering.

There are two important and crucial points:

  - guaranteeing inclusion ordering,
  - guaranteeing single inclusion.

If only the first were needed, then we could simply include the tools
here without renaming; they'd be included twice, but that is not a
problem for the first point.

But the second point is also important, because we do not want tools to
register themselves twice, nor do we want they break their variables by
appending stuff already added.

So, I would keep your comment as is, except I'd add a bit on the third
and last lines:

# Note: we need individual tools makefiles to be included *before* we build
# the list of build and install hooks below to guarantee that each tool has
# a chance to register itself once, and only once. Therefore, the makefiles
# are named linux-tool-*.mk.in, so they won't be picked up by the top-level
# Makefile, but can be included here, guaranteeing the single inclusion and
# the proper ordering.

(Bonus point: ithe comment all lines up perfectly well, now! ;-] )

No need to respin, I gues, a maintainer can tweak the message when
applying.

Thanks! :-)

Regards,
Yann E. MORIN.

> +include $(sort $(wildcard package/linux-tools/*.mk.in))
>  
>  # We only need the kernel to be extracted, not actually built
>  LINUX_TOOLS_PATCH_DEPENDENCIES = linux
> -- 
> 2.7.4
> 
> _______________________________________________
> buildroot mailing list
> buildroot@busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot
Markus Mayer July 18, 2017, 7:36 p.m. UTC | #2
On 18 July 2017 at 12:06, Yann E. MORIN <yann.morin.1998@free.fr> wrote:
> Markus, All,
>
> On 2017-07-18 11:11 -0700, Markus Mayer spake thusly:
>> Make inclusion ordering of all linux-tool-*.mk sub-makefiles explicit
>> instead of relying on alphabetical sort order. This is done by
>> renaming the Linux tools sub-makefiles to the format linux-tool-*.mk.in.
>> This causes the top-level Makefile to ignore the Linux tools
>> sub-makefiles.
>>
>> Until now, the main Makefile included all linux-tool-*.mk files, as
>> well as linux-tools.mk, and it relied on alphabetical sorting to
>> include them in the proper order (linux-tool-*.mk before
>> linux-tools.mk).
>>
>> Signed-off-by: Markus Mayer <mmayer@broadcom.com>
>
> Thank you for this new iteration.
>
> I have a small comment, see below...
>
> [--SNIP--]
>> diff --git a/package/linux-tools/linux-tools.mk b/package/linux-tools/linux-tools.mk
>> index 7fa8d19..2827ade 100644
>> --- a/package/linux-tools/linux-tools.mk
>> +++ b/package/linux-tools/linux-tools.mk
>> @@ -10,15 +10,13 @@
>>  #
>>  # So, all tools refer to $(LINUX_DIR) instead of $(@D).
>>
>> -# Note: we need individual tools .mk files to be included *before* this one
>> -# to guarantee that each tool has a chance to register itself before we build
>> -# the list of build and install hooks, below.
>> -#
>> -# This is currently guaranteed by the naming of each file:
>> -# - they get included by the top-level Makefile, with $(sort $(wildcard ...))
>> -# - make's $(sort) function will aways sort in the C locale
>> -# - the files names correctly sort out in the C locale so that each tool's
>> -#   .mk file is included before this one.
>> +# Note: we need individual tools makefiles to be included *before* we build
>> +# the list of build and install hooks below to guarantee that each tool has
>> +# a chance to register itself. Therefore, the makefiles are named
>> +# linux-tool-*.mk.in, so they won't be picked up by the top-level Makefile,
>> +# but can be included here, guaranteeing proper ordering.
>
> There are two important and crucial points:
>
>   - guaranteeing inclusion ordering,
>   - guaranteeing single inclusion.
>
> If only the first were needed, then we could simply include the tools
> here without renaming; they'd be included twice, but that is not a
> problem for the first point.
>
> But the second point is also important, because we do not want tools to
> register themselves twice, nor do we want they break their variables by
> appending stuff already added.
>
> So, I would keep your comment as is, except I'd add a bit on the third
> and last lines:
>
> # Note: we need individual tools makefiles to be included *before* we build
> # the list of build and install hooks below to guarantee that each tool has
> # a chance to register itself once, and only once. Therefore, the makefiles
> # are named linux-tool-*.mk.in, so they won't be picked up by the top-level
> # Makefile, but can be included here, guaranteeing the single inclusion and
> # the proper ordering.

That makes perfect sense to me. Thanks for adding it.

> (Bonus point: ithe comment all lines up perfectly well, now! ;-] )
>
> No need to respin, I gues, a maintainer can tweak the message when
> applying.

Sure. I'll hold off for now. Should this change for whatever reason,
please let me know, and I'll send an updated revision.

> Thanks! :-)
>
> Regards,
> Yann E. MORIN.
>
>> +include $(sort $(wildcard package/linux-tools/*.mk.in))
>>
>>  # We only need the kernel to be extracted, not actually built
>>  LINUX_TOOLS_PATCH_DEPENDENCIES = linux
>> --
>> 2.7.4
>>
>> _______________________________________________
>> buildroot mailing list
>> buildroot@busybox.net
>> http://lists.busybox.net/mailman/listinfo/buildroot
>
> --
> .-----------------.--------------------.------------------.--------------------.
> |  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
> | +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
> | +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
> | http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
> '------------------------------^-------^------------------^--------------------'
Yann E. MORIN July 18, 2017, 7:38 p.m. UTC | #3
Markus, All,

On 2017-07-18 12:36 -0700, Markus Mayer spake thusly:
> On 18 July 2017 at 12:06, Yann E. MORIN <yann.morin.1998@free.fr> wrote:
> > Markus, All,
> >
> > On 2017-07-18 11:11 -0700, Markus Mayer spake thusly:
> >> Make inclusion ordering of all linux-tool-*.mk sub-makefiles explicit
> >> instead of relying on alphabetical sort order. This is done by
> >> renaming the Linux tools sub-makefiles to the format linux-tool-*.mk.in.
> >> This causes the top-level Makefile to ignore the Linux tools
> >> sub-makefiles.
> >>
> >> Until now, the main Makefile included all linux-tool-*.mk files, as
> >> well as linux-tools.mk, and it relied on alphabetical sorting to
> >> include them in the proper order (linux-tool-*.mk before
> >> linux-tools.mk).
> >>
> >> Signed-off-by: Markus Mayer <mmayer@broadcom.com>
> >
> > Thank you for this new iteration.
> >
> > I have a small comment, see below...
> >
> > [--SNIP--]
> >> diff --git a/package/linux-tools/linux-tools.mk b/package/linux-tools/linux-tools.mk
> >> index 7fa8d19..2827ade 100644
> >> --- a/package/linux-tools/linux-tools.mk
> >> +++ b/package/linux-tools/linux-tools.mk
> >> @@ -10,15 +10,13 @@
> >>  #
> >>  # So, all tools refer to $(LINUX_DIR) instead of $(@D).
> >>
> >> -# Note: we need individual tools .mk files to be included *before* this one
> >> -# to guarantee that each tool has a chance to register itself before we build
> >> -# the list of build and install hooks, below.
> >> -#
> >> -# This is currently guaranteed by the naming of each file:
> >> -# - they get included by the top-level Makefile, with $(sort $(wildcard ...))
> >> -# - make's $(sort) function will aways sort in the C locale
> >> -# - the files names correctly sort out in the C locale so that each tool's
> >> -#   .mk file is included before this one.
> >> +# Note: we need individual tools makefiles to be included *before* we build
> >> +# the list of build and install hooks below to guarantee that each tool has
> >> +# a chance to register itself. Therefore, the makefiles are named
> >> +# linux-tool-*.mk.in, so they won't be picked up by the top-level Makefile,
> >> +# but can be included here, guaranteeing proper ordering.
> >
> > There are two important and crucial points:
> >
> >   - guaranteeing inclusion ordering,
> >   - guaranteeing single inclusion.
> >
> > If only the first were needed, then we could simply include the tools
> > here without renaming; they'd be included twice, but that is not a
> > problem for the first point.
> >
> > But the second point is also important, because we do not want tools to
> > register themselves twice, nor do we want they break their variables by
> > appending stuff already added.
> >
> > So, I would keep your comment as is, except I'd add a bit on the third
> > and last lines:
> >
> > # Note: we need individual tools makefiles to be included *before* we build
> > # the list of build and install hooks below to guarantee that each tool has
> > # a chance to register itself once, and only once. Therefore, the makefiles
> > # are named linux-tool-*.mk.in, so they won't be picked up by the top-level
> > # Makefile, but can be included here, guaranteeing the single inclusion and
> > # the proper ordering.
> 
> That makes perfect sense to me. Thanks for adding it.
> 
> > (Bonus point: ithe comment all lines up perfectly well, now! ;-] )
> >
> > No need to respin, I gues, a maintainer can tweak the message when
> > applying.
> 
> Sure. I'll hold off for now. Should this change for whatever reason,
> please let me know, and I'll send an updated revision.

Since we agree, and with the above ammended at commit time:

Acked-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Regards,
Yann E. MORIN.

> > Thanks! :-)
> >
> > Regards,
> > Yann E. MORIN.
> >
> >> +include $(sort $(wildcard package/linux-tools/*.mk.in))
> >>
> >>  # We only need the kernel to be extracted, not actually built
> >>  LINUX_TOOLS_PATCH_DEPENDENCIES = linux
> >> --
> >> 2.7.4
> >>
> >> _______________________________________________
> >> buildroot mailing list
> >> buildroot@busybox.net
> >> http://lists.busybox.net/mailman/listinfo/buildroot
> >
> > --
> > .-----------------.--------------------.------------------.--------------------.
> > |  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
> > | +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
> > | +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
> > | http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
> > '------------------------------^-------^------------------^--------------------'
Thomas Petazzoni July 19, 2017, 7:35 p.m. UTC | #4
Hello,

On Tue, 18 Jul 2017 11:11:37 -0700, Markus Mayer wrote:
> Make inclusion ordering of all linux-tool-*.mk sub-makefiles explicit
> instead of relying on alphabetical sort order. This is done by
> renaming the Linux tools sub-makefiles to the format linux-tool-*.mk.in.
> This causes the top-level Makefile to ignore the Linux tools
> sub-makefiles.
> 
> Until now, the main Makefile included all linux-tool-*.mk files, as
> well as linux-tools.mk, and it relied on alphabetical sorting to
> include them in the proper order (linux-tool-*.mk before
> linux-tools.mk).
> 
> Signed-off-by: Markus Mayer <mmayer@broadcom.com>
> ---

I've taken into account the improvements suggested by Yann and applied.
Thanks!

Thomas
diff mbox

Patch

diff --git a/docs/manual/adding-packages-linux-kernel-spec-infra.txt b/docs/manual/adding-packages-linux-kernel-spec-infra.txt
index 6deb6d4..b948e20 100644
--- a/docs/manual/adding-packages-linux-kernel-spec-infra.txt
+++ b/docs/manual/adding-packages-linux-kernel-spec-infra.txt
@@ -40,8 +40,8 @@  Unlike other packages, the +linux-tools+ package options appear in the
 +linux+ kernel menu, under the `Linux Kernel Tools` sub-menu, not under
 the `Target packages` main menu.
 
-Then for each linux tool, add a new +.mk+ file named
-+package/linux-tools/linux-tool-foo.mk+. It would basically look like:
+Then for each linux tool, add a new +.mk.in+ file named
++package/linux-tools/linux-tool-foo.mk.in+. It would basically look like:
 
 ------------------------------
 01: ################################################################################
diff --git a/package/linux-tools/linux-tool-cpupower.mk b/package/linux-tools/linux-tool-cpupower.mk.in
similarity index 100%
rename from package/linux-tools/linux-tool-cpupower.mk
rename to package/linux-tools/linux-tool-cpupower.mk.in
diff --git a/package/linux-tools/linux-tool-gpio.mk b/package/linux-tools/linux-tool-gpio.mk.in
similarity index 100%
rename from package/linux-tools/linux-tool-gpio.mk
rename to package/linux-tools/linux-tool-gpio.mk.in
diff --git a/package/linux-tools/linux-tool-iio.mk b/package/linux-tools/linux-tool-iio.mk.in
similarity index 100%
rename from package/linux-tools/linux-tool-iio.mk
rename to package/linux-tools/linux-tool-iio.mk.in
diff --git a/package/linux-tools/linux-tool-perf.mk b/package/linux-tools/linux-tool-perf.mk.in
similarity index 100%
rename from package/linux-tools/linux-tool-perf.mk
rename to package/linux-tools/linux-tool-perf.mk.in
diff --git a/package/linux-tools/linux-tool-selftests.mk b/package/linux-tools/linux-tool-selftests.mk.in
similarity index 100%
rename from package/linux-tools/linux-tool-selftests.mk
rename to package/linux-tools/linux-tool-selftests.mk.in
diff --git a/package/linux-tools/linux-tools.mk b/package/linux-tools/linux-tools.mk
index 7fa8d19..2827ade 100644
--- a/package/linux-tools/linux-tools.mk
+++ b/package/linux-tools/linux-tools.mk
@@ -10,15 +10,13 @@ 
 #
 # So, all tools refer to $(LINUX_DIR) instead of $(@D).
 
-# Note: we need individual tools .mk files to be included *before* this one
-# to guarantee that each tool has a chance to register itself before we build
-# the list of build and install hooks, below.
-#
-# This is currently guaranteed by the naming of each file:
-# - they get included by the top-level Makefile, with $(sort $(wildcard ...))
-# - make's $(sort) function will aways sort in the C locale
-# - the files names correctly sort out in the C locale so that each tool's
-#   .mk file is included before this one.
+# Note: we need individual tools makefiles to be included *before* we build
+# the list of build and install hooks below to guarantee that each tool has
+# a chance to register itself. Therefore, the makefiles are named
+# linux-tool-*.mk.in, so they won't be picked up by the top-level Makefile,
+# but can be included here, guaranteeing proper ordering.
+
+include $(sort $(wildcard package/linux-tools/*.mk.in))
 
 # We only need the kernel to be extracted, not actually built
 LINUX_TOOLS_PATCH_DEPENDENCIES = linux