* [Buildroot] [PATCH 1/1] core: rename FOO_BASE_NAME to FOO_BASENAME to avoid clashes
@ 2018-02-05 14:29 Thomas De Schampheleire
2018-02-05 14:54 ` Yann E. MORIN
2018-02-05 22:23 ` Cam Hutchison
0 siblings, 2 replies; 7+ messages in thread
From: Thomas De Schampheleire @ 2018-02-05 14:29 UTC (permalink / raw)
To: buildroot
In current Buildroot, clashes occur between the variables _NAME and
_BASE_NAME for two packages called foo and foo-base, i.e.
Package foo:
FOO_NAME = foo
FOO_BASE_NAME = foo-1.2.3
Package foo-base:
FOO_BASE_NAME = foo-base
FOO_BASE_BASE_NAME = foo-base-4.5.6
where variable FOO_BASE_NAME is clashing between these two packages.
The problem is generic and can occur for a number of variables in Buildroot.
One solution is to use a different separator than '_' to separate the
package name from the rest of the variable name. For example:
FOO_NAME could become FOO.NAME, FOO-NAME, or something else.
Then, in the example we would have following non-clashing variables:
FOO.NAME
FOO.BASE_NAME
FOO_BASE.NAME
FOO_BASE.BASE_NAME
However, making that change for only this case means that the variable
naming is no longer consistent. And making the change for all variables has
a large impact, also on certain user scripts.
For now, keep it simple, and rename FOO_BASE_NAME into FOO_BASENAME, so that
the variables become:
FOO_NAME
FOO_BASENAME
FOO_BASE_NAME
FOO_BASE_BASENAME
Signed-off-by: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
---
package/pkg-download.mk | 10 +++++-----
package/pkg-generic.mk | 14 +++++++-------
2 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/package/pkg-download.mk b/package/pkg-download.mk
index 3712b9ccc6..14091a4646 100644
--- a/package/pkg-download.mk
+++ b/package/pkg-download.mk
@@ -79,7 +79,7 @@ define DOWNLOAD_GIT
-- \
$($(PKG)_SITE) \
$($(PKG)_DL_VERSION) \
- $($(PKG)_RAW_BASE_NAME) \
+ $($(PKG)_RAW_BASENAME) \
$($(PKG)_DL_OPTS)
endef
@@ -90,7 +90,7 @@ define DOWNLOAD_BZR
-- \
$($(PKG)_SITE) \
$($(PKG)_DL_VERSION) \
- $($(PKG)_RAW_BASE_NAME) \
+ $($(PKG)_RAW_BASENAME) \
$($(PKG)_DL_OPTS)
endef
@@ -102,7 +102,7 @@ define DOWNLOAD_CVS
$(call stripurischeme,$(call qstrip,$($(PKG)_SITE))) \
$($(PKG)_DL_VERSION) \
$($(PKG)_RAWNAME) \
- $($(PKG)_RAW_BASE_NAME) \
+ $($(PKG)_RAW_BASENAME) \
$($(PKG)_DL_OPTS)
endef
@@ -113,7 +113,7 @@ define DOWNLOAD_SVN
-- \
$($(PKG)_SITE) \
$($(PKG)_DL_VERSION) \
- $($(PKG)_RAW_BASE_NAME) \
+ $($(PKG)_RAW_BASENAME) \
$($(PKG)_DL_OPTS)
endef
@@ -137,7 +137,7 @@ define DOWNLOAD_HG
-- \
$($(PKG)_SITE) \
$($(PKG)_DL_VERSION) \
- $($(PKG)_RAW_BASE_NAME) \
+ $($(PKG)_RAW_BASENAME) \
$($(PKG)_DL_OPTS)
endef
diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
index a2a12e7b56..9a76cb3b8a 100644
--- a/package/pkg-generic.mk
+++ b/package/pkg-generic.mk
@@ -452,10 +452,10 @@ ifdef $(3)_OVERRIDE_SRCDIR
$(2)_OVERRIDE_SRCDIR ?= $$($(3)_OVERRIDE_SRCDIR)
endif
-$(2)_BASE_NAME = $$(if $$($(2)_VERSION),$(1)-$$($(2)_VERSION),$(1))
-$(2)_RAW_BASE_NAME = $$(if $$($(2)_VERSION),$$($(2)_RAWNAME)-$$($(2)_VERSION),$$($(2)_RAWNAME))
+$(2)_BASENAME = $$(if $$($(2)_VERSION),$(1)-$$($(2)_VERSION),$(1))
+$(2)_RAW_BASENAME = $$(if $$($(2)_VERSION),$$($(2)_RAWNAME)-$$($(2)_VERSION),$$($(2)_RAWNAME))
$(2)_DL_DIR = $$(DL_DIR)
-$(2)_DIR = $$(BUILD_DIR)/$$($(2)_BASE_NAME)
+$(2)_DIR = $$(BUILD_DIR)/$$($(2)_BASENAME)
ifndef $(2)_SUBDIR
ifdef $(3)_SUBDIR
@@ -484,7 +484,7 @@ ifndef $(2)_SOURCE
ifdef $(3)_SOURCE
$(2)_SOURCE = $$($(3)_SOURCE)
else ifdef $(2)_VERSION
- $(2)_SOURCE ?= $$($(2)_RAW_BASE_NAME).tar.gz
+ $(2)_SOURCE ?= $$($(2)_RAW_BASENAME).tar.gz
endif
endif
@@ -558,7 +558,7 @@ endif
$(2)_REDISTRIBUTE ?= YES
-$(2)_REDIST_SOURCES_DIR = $$(REDIST_SOURCES_DIR_$$(call UPPERCASE,$(4)))/$$($(2)_RAW_BASE_NAME)
+$(2)_REDIST_SOURCES_DIR = $$(REDIST_SOURCES_DIR_$$(call UPPERCASE,$(4)))/$$($(2)_RAW_BASENAME)
# When a target package is a toolchain dependency set this variable to
# 'NO' so the 'toolchain' dependency is not added to prevent a circular
@@ -864,9 +864,9 @@ ifneq ($$(call qstrip,$$($(2)_SOURCE)),)
# is that the license still applies to the files distributed as part
# of the rootfs, even if the sources are not themselves redistributed.
ifeq ($$(call qstrip,$$($(2)_LICENSE_FILES)),)
- $(Q)$$(call legal-warning-pkg,$$($(2)_RAW_BASE_NAME),cannot save license ($(2)_LICENSE_FILES not defined))
+ $(Q)$$(call legal-warning-pkg,$$($(2)_RAW_BASENAME),cannot save license ($(2)_LICENSE_FILES not defined))
else
- $(Q)$$(foreach F,$$($(2)_LICENSE_FILES),$$(call legal-license-file,$$($(2)_RAWNAME),$$($(2)_RAW_BASE_NAME),$$($(2)_PKGDIR),$$(F),$$($(2)_DIR)/$$(F),$$(call UPPERCASE,$(4)))$$(sep))
+ $(Q)$$(foreach F,$$($(2)_LICENSE_FILES),$$(call legal-license-file,$$($(2)_RAWNAME),$$($(2)_RAW_BASENAME),$$($(2)_PKGDIR),$$(F),$$($(2)_DIR)/$$(F),$$(call UPPERCASE,$(4)))$$(sep))
endif # license files
ifeq ($$($(2)_SITE_METHOD),local)
--
2.13.6
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [Buildroot] [PATCH 1/1] core: rename FOO_BASE_NAME to FOO_BASENAME to avoid clashes
2018-02-05 14:29 [Buildroot] [PATCH 1/1] core: rename FOO_BASE_NAME to FOO_BASENAME to avoid clashes Thomas De Schampheleire
@ 2018-02-05 14:54 ` Yann E. MORIN
2018-02-06 10:13 ` Thomas De Schampheleire
2018-02-06 10:17 ` Thomas De Schampheleire
2018-02-05 22:23 ` Cam Hutchison
1 sibling, 2 replies; 7+ messages in thread
From: Yann E. MORIN @ 2018-02-05 14:54 UTC (permalink / raw)
To: buildroot
Thomas, All,
Quick review before in-depth review and testing...
On 2018-02-05 15:29 +0100, Thomas De Schampheleire spake thusly:
> In current Buildroot, clashes occur between the variables _NAME and
> _BASE_NAME for two packages called foo and foo-base, i.e.
>
> Package foo:
> FOO_NAME = foo
> FOO_BASE_NAME = foo-1.2.3
>
> Package foo-base:
> FOO_BASE_NAME = foo-base
> FOO_BASE_BASE_NAME = foo-base-4.5.6
>
> where variable FOO_BASE_NAME is clashing between these two packages.
>
> The problem is generic and can occur for a number of variables in Buildroot.
> One solution is to use a different separator than '_' to separate the
> package name from the rest of the variable name. For example:
> FOO_NAME could become FOO.NAME, FOO-NAME, or something else.
> Then, in the example we would have following non-clashing variables:
> FOO.NAME
> FOO.BASE_NAME
> FOO_BASE.NAME
> FOO_BASE.BASE_NAME
Another isadvantage is that those variables are not valid shell
variables, so we ca=ould no longer use constructs like:
eval $(make -s printvars VARS=FOO.BASE_NAME)
or similar...
But this is also an advantage, in that those variable won't accidentally
leak into the environment of _CMDS...
But the disadvantage is more critical.
> However, making that change for only this case means that the variable
> naming is no longer consistent. And making the change for all variables has
> a large impact, also on certain user scripts.
>
> For now, keep it simple, and rename FOO_BASE_NAME into FOO_BASENAME, so that
> the variables become:
> FOO_NAME
> FOO_BASENAME
> FOO_BASE_NAME
> FOO_BASE_BASENAME
You're listing _NAME and _BASENAME, but are also changing _RAW_BASENAME.
Regards,
Yann E. MORIN.
> Signed-off-by: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
> ---
> package/pkg-download.mk | 10 +++++-----
> package/pkg-generic.mk | 14 +++++++-------
> 2 files changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/package/pkg-download.mk b/package/pkg-download.mk
> index 3712b9ccc6..14091a4646 100644
> --- a/package/pkg-download.mk
> +++ b/package/pkg-download.mk
> @@ -79,7 +79,7 @@ define DOWNLOAD_GIT
> -- \
> $($(PKG)_SITE) \
> $($(PKG)_DL_VERSION) \
> - $($(PKG)_RAW_BASE_NAME) \
> + $($(PKG)_RAW_BASENAME) \
> $($(PKG)_DL_OPTS)
> endef
>
> @@ -90,7 +90,7 @@ define DOWNLOAD_BZR
> -- \
> $($(PKG)_SITE) \
> $($(PKG)_DL_VERSION) \
> - $($(PKG)_RAW_BASE_NAME) \
> + $($(PKG)_RAW_BASENAME) \
> $($(PKG)_DL_OPTS)
> endef
>
> @@ -102,7 +102,7 @@ define DOWNLOAD_CVS
> $(call stripurischeme,$(call qstrip,$($(PKG)_SITE))) \
> $($(PKG)_DL_VERSION) \
> $($(PKG)_RAWNAME) \
> - $($(PKG)_RAW_BASE_NAME) \
> + $($(PKG)_RAW_BASENAME) \
> $($(PKG)_DL_OPTS)
> endef
>
> @@ -113,7 +113,7 @@ define DOWNLOAD_SVN
> -- \
> $($(PKG)_SITE) \
> $($(PKG)_DL_VERSION) \
> - $($(PKG)_RAW_BASE_NAME) \
> + $($(PKG)_RAW_BASENAME) \
> $($(PKG)_DL_OPTS)
> endef
>
> @@ -137,7 +137,7 @@ define DOWNLOAD_HG
> -- \
> $($(PKG)_SITE) \
> $($(PKG)_DL_VERSION) \
> - $($(PKG)_RAW_BASE_NAME) \
> + $($(PKG)_RAW_BASENAME) \
> $($(PKG)_DL_OPTS)
> endef
>
> diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
> index a2a12e7b56..9a76cb3b8a 100644
> --- a/package/pkg-generic.mk
> +++ b/package/pkg-generic.mk
> @@ -452,10 +452,10 @@ ifdef $(3)_OVERRIDE_SRCDIR
> $(2)_OVERRIDE_SRCDIR ?= $$($(3)_OVERRIDE_SRCDIR)
> endif
>
> -$(2)_BASE_NAME = $$(if $$($(2)_VERSION),$(1)-$$($(2)_VERSION),$(1))
> -$(2)_RAW_BASE_NAME = $$(if $$($(2)_VERSION),$$($(2)_RAWNAME)-$$($(2)_VERSION),$$($(2)_RAWNAME))
> +$(2)_BASENAME = $$(if $$($(2)_VERSION),$(1)-$$($(2)_VERSION),$(1))
> +$(2)_RAW_BASENAME = $$(if $$($(2)_VERSION),$$($(2)_RAWNAME)-$$($(2)_VERSION),$$($(2)_RAWNAME))
> $(2)_DL_DIR = $$(DL_DIR)
> -$(2)_DIR = $$(BUILD_DIR)/$$($(2)_BASE_NAME)
> +$(2)_DIR = $$(BUILD_DIR)/$$($(2)_BASENAME)
>
> ifndef $(2)_SUBDIR
> ifdef $(3)_SUBDIR
> @@ -484,7 +484,7 @@ ifndef $(2)_SOURCE
> ifdef $(3)_SOURCE
> $(2)_SOURCE = $$($(3)_SOURCE)
> else ifdef $(2)_VERSION
> - $(2)_SOURCE ?= $$($(2)_RAW_BASE_NAME).tar.gz
> + $(2)_SOURCE ?= $$($(2)_RAW_BASENAME).tar.gz
> endif
> endif
>
> @@ -558,7 +558,7 @@ endif
>
> $(2)_REDISTRIBUTE ?= YES
>
> -$(2)_REDIST_SOURCES_DIR = $$(REDIST_SOURCES_DIR_$$(call UPPERCASE,$(4)))/$$($(2)_RAW_BASE_NAME)
> +$(2)_REDIST_SOURCES_DIR = $$(REDIST_SOURCES_DIR_$$(call UPPERCASE,$(4)))/$$($(2)_RAW_BASENAME)
>
> # When a target package is a toolchain dependency set this variable to
> # 'NO' so the 'toolchain' dependency is not added to prevent a circular
> @@ -864,9 +864,9 @@ ifneq ($$(call qstrip,$$($(2)_SOURCE)),)
> # is that the license still applies to the files distributed as part
> # of the rootfs, even if the sources are not themselves redistributed.
> ifeq ($$(call qstrip,$$($(2)_LICENSE_FILES)),)
> - $(Q)$$(call legal-warning-pkg,$$($(2)_RAW_BASE_NAME),cannot save license ($(2)_LICENSE_FILES not defined))
> + $(Q)$$(call legal-warning-pkg,$$($(2)_RAW_BASENAME),cannot save license ($(2)_LICENSE_FILES not defined))
> else
> - $(Q)$$(foreach F,$$($(2)_LICENSE_FILES),$$(call legal-license-file,$$($(2)_RAWNAME),$$($(2)_RAW_BASE_NAME),$$($(2)_PKGDIR),$$(F),$$($(2)_DIR)/$$(F),$$(call UPPERCASE,$(4)))$$(sep))
> + $(Q)$$(foreach F,$$($(2)_LICENSE_FILES),$$(call legal-license-file,$$($(2)_RAWNAME),$$($(2)_RAW_BASENAME),$$($(2)_PKGDIR),$$(F),$$($(2)_DIR)/$$(F),$$(call UPPERCASE,$(4)))$$(sep))
> endif # license files
>
> ifeq ($$($(2)_SITE_METHOD),local)
> --
> 2.13.6
>
> _______________________________________________
> buildroot mailing list
> buildroot at 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. |
'------------------------------^-------^------------------^--------------------'
^ permalink raw reply [flat|nested] 7+ messages in thread
* [Buildroot] [PATCH 1/1] core: rename FOO_BASE_NAME to FOO_BASENAME to avoid clashes
2018-02-05 14:29 [Buildroot] [PATCH 1/1] core: rename FOO_BASE_NAME to FOO_BASENAME to avoid clashes Thomas De Schampheleire
2018-02-05 14:54 ` Yann E. MORIN
@ 2018-02-05 22:23 ` Cam Hutchison
1 sibling, 0 replies; 7+ messages in thread
From: Cam Hutchison @ 2018-02-05 22:23 UTC (permalink / raw)
To: buildroot
On 6 February 2018 at 01:29, Thomas De Schampheleire
<thomas.de_schampheleire@nokia.com> wrote:
> In current Buildroot, clashes occur between the variables _NAME and
> _BASE_NAME for two packages called foo and foo-base, i.e.
>
> Package foo:
> FOO_NAME = foo
> FOO_BASE_NAME = foo-1.2.3
>
> Package foo-base:
> FOO_BASE_NAME = foo-base
> FOO_BASE_BASE_NAME = foo-base-4.5.6
>
> where variable FOO_BASE_NAME is clashing between these two packages.
>
> The problem is generic and can occur for a number of variables in Buildroot.
> One solution is to use a different separator than '_' to separate the
> package name from the rest of the variable name. For example:
> FOO_NAME could become FOO.NAME, FOO-NAME, or something else.
> Then, in the example we would have following non-clashing variables:
> FOO.NAME
> FOO.BASE_NAME
> FOO_BASE.NAME
> FOO_BASE.BASE_NAME
>
> However, making that change for only this case means that the variable
> naming is no longer consistent. And making the change for all variables has
> a large impact, also on certain user scripts.
>
> For now, keep it simple, and rename FOO_BASE_NAME into FOO_BASENAME, so that
> the variables become:
> FOO_NAME
> FOO_BASENAME
> FOO_BASE_NAME
> FOO_BASE_BASENAME
>
> Signed-off-by: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
> ---
> package/pkg-download.mk | 10 +++++-----
> package/pkg-generic.mk | 14 +++++++-------
> 2 files changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/package/pkg-download.mk b/package/pkg-download.mk
> index 3712b9ccc6..14091a4646 100644
> --- a/package/pkg-download.mk
> +++ b/package/pkg-download.mk
> @@ -79,7 +79,7 @@ define DOWNLOAD_GIT
> -- \
> $($(PKG)_SITE) \
> $($(PKG)_DL_VERSION) \
> - $($(PKG)_RAW_BASE_NAME) \
> + $($(PKG)_RAW_BASENAME) \
> $($(PKG)_DL_OPTS)
> endef
>
> @@ -90,7 +90,7 @@ define DOWNLOAD_BZR
> -- \
> $($(PKG)_SITE) \
> $($(PKG)_DL_VERSION) \
> - $($(PKG)_RAW_BASE_NAME) \
> + $($(PKG)_RAW_BASENAME) \
> $($(PKG)_DL_OPTS)
> endef
>
> @@ -102,7 +102,7 @@ define DOWNLOAD_CVS
> $(call stripurischeme,$(call qstrip,$($(PKG)_SITE))) \
> $($(PKG)_DL_VERSION) \
> $($(PKG)_RAWNAME) \
> - $($(PKG)_RAW_BASE_NAME) \
> + $($(PKG)_RAW_BASENAME) \
> $($(PKG)_DL_OPTS)
> endef
>
> @@ -113,7 +113,7 @@ define DOWNLOAD_SVN
> -- \
> $($(PKG)_SITE) \
> $($(PKG)_DL_VERSION) \
> - $($(PKG)_RAW_BASE_NAME) \
> + $($(PKG)_RAW_BASENAME) \
> $($(PKG)_DL_OPTS)
> endef
>
> @@ -137,7 +137,7 @@ define DOWNLOAD_HG
> -- \
> $($(PKG)_SITE) \
> $($(PKG)_DL_VERSION) \
> - $($(PKG)_RAW_BASE_NAME) \
> + $($(PKG)_RAW_BASENAME) \
> $($(PKG)_DL_OPTS)
> endef
>
> diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
> index a2a12e7b56..9a76cb3b8a 100644
> --- a/package/pkg-generic.mk
> +++ b/package/pkg-generic.mk
> @@ -452,10 +452,10 @@ ifdef $(3)_OVERRIDE_SRCDIR
> $(2)_OVERRIDE_SRCDIR ?= $$($(3)_OVERRIDE_SRCDIR)
> endif
>
> -$(2)_BASE_NAME = $$(if $$($(2)_VERSION),$(1)-$$($(2)_VERSION),$(1))
> -$(2)_RAW_BASE_NAME = $$(if $$($(2)_VERSION),$$($(2)_RAWNAME)-$$($(2)_VERSION),$$($(2)_RAWNAME))
> +$(2)_BASENAME = $$(if $$($(2)_VERSION),$(1)-$$($(2)_VERSION),$(1))
> +$(2)_RAW_BASENAME = $$(if $$($(2)_VERSION),$$($(2)_RAWNAME)-$$($(2)_VERSION),$$($(2)_RAWNAME))
Doesn't this have the same problem? e.g. package foo and foo-raw
will now have conflicting variables.
If this patch is just to address some specific cases with existing
packages, can you list those packages in the commit message?
> $(2)_DL_DIR = $$(DL_DIR)
> -$(2)_DIR = $$(BUILD_DIR)/$$($(2)_BASE_NAME)
> +$(2)_DIR = $$(BUILD_DIR)/$$($(2)_BASENAME)
>
> ifndef $(2)_SUBDIR
> ifdef $(3)_SUBDIR
> @@ -484,7 +484,7 @@ ifndef $(2)_SOURCE
> ifdef $(3)_SOURCE
> $(2)_SOURCE = $$($(3)_SOURCE)
> else ifdef $(2)_VERSION
> - $(2)_SOURCE ?= $$($(2)_RAW_BASE_NAME).tar.gz
> + $(2)_SOURCE ?= $$($(2)_RAW_BASENAME).tar.gz
> endif
> endif
>
> @@ -558,7 +558,7 @@ endif
>
> $(2)_REDISTRIBUTE ?= YES
>
> -$(2)_REDIST_SOURCES_DIR = $$(REDIST_SOURCES_DIR_$$(call UPPERCASE,$(4)))/$$($(2)_RAW_BASE_NAME)
> +$(2)_REDIST_SOURCES_DIR = $$(REDIST_SOURCES_DIR_$$(call UPPERCASE,$(4)))/$$($(2)_RAW_BASENAME)
>
> # When a target package is a toolchain dependency set this variable to
> # 'NO' so the 'toolchain' dependency is not added to prevent a circular
> @@ -864,9 +864,9 @@ ifneq ($$(call qstrip,$$($(2)_SOURCE)),)
> # is that the license still applies to the files distributed as part
> # of the rootfs, even if the sources are not themselves redistributed.
> ifeq ($$(call qstrip,$$($(2)_LICENSE_FILES)),)
> - $(Q)$$(call legal-warning-pkg,$$($(2)_RAW_BASE_NAME),cannot save license ($(2)_LICENSE_FILES not defined))
> + $(Q)$$(call legal-warning-pkg,$$($(2)_RAW_BASENAME),cannot save license ($(2)_LICENSE_FILES not defined))
> else
> - $(Q)$$(foreach F,$$($(2)_LICENSE_FILES),$$(call legal-license-file,$$($(2)_RAWNAME),$$($(2)_RAW_BASE_NAME),$$($(2)_PKGDIR),$$(F),$$($(2)_DIR)/$$(F),$$(call UPPERCASE,$(4)))$$(sep))
> + $(Q)$$(foreach F,$$($(2)_LICENSE_FILES),$$(call legal-license-file,$$($(2)_RAWNAME),$$($(2)_RAW_BASENAME),$$($(2)_PKGDIR),$$(F),$$($(2)_DIR)/$$(F),$$(call UPPERCASE,$(4)))$$(sep))
> endif # license files
>
> ifeq ($$($(2)_SITE_METHOD),local)
> --
> 2.13.6
>
> _______________________________________________
> buildroot mailing list
> buildroot at busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot
^ permalink raw reply [flat|nested] 7+ messages in thread
* [Buildroot] [PATCH 1/1] core: rename FOO_BASE_NAME to FOO_BASENAME to avoid clashes
2018-02-05 14:54 ` Yann E. MORIN
@ 2018-02-06 10:13 ` Thomas De Schampheleire
2018-02-06 12:41 ` Arnout Vandecappelle
2018-02-06 10:17 ` Thomas De Schampheleire
1 sibling, 1 reply; 7+ messages in thread
From: Thomas De Schampheleire @ 2018-02-06 10:13 UTC (permalink / raw)
To: buildroot
On Mon, Feb 05, 2018 at 03:54:50PM +0100, Yann E. MORIN wrote:
> Thomas, All,
>
> Quick review before in-depth review and testing...
>
> On 2018-02-05 15:29 +0100, Thomas De Schampheleire spake thusly:
> > In current Buildroot, clashes occur between the variables _NAME and
> > _BASE_NAME for two packages called foo and foo-base, i.e.
> >
> > Package foo:
> > FOO_NAME = foo
> > FOO_BASE_NAME = foo-1.2.3
> >
> > Package foo-base:
> > FOO_BASE_NAME = foo-base
> > FOO_BASE_BASE_NAME = foo-base-4.5.6
> >
> > where variable FOO_BASE_NAME is clashing between these two packages.
> >
> > The problem is generic and can occur for a number of variables in Buildroot.
> > One solution is to use a different separator than '_' to separate the
> > package name from the rest of the variable name. For example:
> > FOO_NAME could become FOO.NAME, FOO-NAME, or something else.
> > Then, in the example we would have following non-clashing variables:
> > FOO.NAME
> > FOO.BASE_NAME
> > FOO_BASE.NAME
> > FOO_BASE.BASE_NAME
>
> Another isadvantage is that those variables are not valid shell
> variables, so we ca=ould no longer use constructs like:
>
> eval $(make -s printvars VARS=FOO.BASE_NAME)
>
> or similar...
>
> But this is also an advantage, in that those variable won't accidentally
> leak into the environment of _CMDS...
>
> But the disadvantage is more critical.
Yes, we didn't think of that.
>
> > However, making that change for only this case means that the variable
> > naming is no longer consistent. And making the change for all variables has
> > a large impact, also on certain user scripts.
> >
> > For now, keep it simple, and rename FOO_BASE_NAME into FOO_BASENAME, so that
> > the variables become:
> > FOO_NAME
> > FOO_BASENAME
> > FOO_BASE_NAME
> > FOO_BASE_BASENAME
>
> You're listing _NAME and _BASENAME, but are also changing _RAW_BASENAME.
Yes, I thought it would have been odd to have
FOO_BASENAME
and
FOO_RAW_BASE_NAME
so I aligned RAW_BASENAME as well.
This still exposes a problem with foo-raw, as Cam Hutchingson also mentioned,
but this is not the only remaining problem.
Renaming FOO_RAW_BASE_NAME into FOO_BASENAME_RAW solves that problem, because
there is no internal variable 'FOO_RAW'.
It still doesn't solve other possible variable clashes, like DL_DIR for 'foo'
with DIR for 'foo-dl'. But as we said, doing the full fix has some disadvantages
as well.
/Thomas
^ permalink raw reply [flat|nested] 7+ messages in thread
* [Buildroot] [PATCH 1/1] core: rename FOO_BASE_NAME to FOO_BASENAME to avoid clashes
2018-02-05 14:54 ` Yann E. MORIN
2018-02-06 10:13 ` Thomas De Schampheleire
@ 2018-02-06 10:17 ` Thomas De Schampheleire
2018-02-06 12:42 ` Arnout Vandecappelle
1 sibling, 1 reply; 7+ messages in thread
From: Thomas De Schampheleire @ 2018-02-06 10:17 UTC (permalink / raw)
To: buildroot
On Mon, Feb 05, 2018 at 03:54:50PM +0100, Yann E. MORIN wrote:
> Thomas, All,
>
> Quick review before in-depth review and testing...
>
> On 2018-02-05 15:29 +0100, Thomas De Schampheleire spake thusly:
> > In current Buildroot, clashes occur between the variables _NAME and
> > _BASE_NAME for two packages called foo and foo-base, i.e.
> >
> > Package foo:
> > FOO_NAME = foo
> > FOO_BASE_NAME = foo-1.2.3
> >
> > Package foo-base:
> > FOO_BASE_NAME = foo-base
> > FOO_BASE_BASE_NAME = foo-base-4.5.6
> >
> > where variable FOO_BASE_NAME is clashing between these two packages.
> >
> > The problem is generic and can occur for a number of variables in Buildroot.
> > One solution is to use a different separator than '_' to separate the
> > package name from the rest of the variable name. For example:
> > FOO_NAME could become FOO.NAME, FOO-NAME, or something else.
> > Then, in the example we would have following non-clashing variables:
> > FOO.NAME
> > FOO.BASE_NAME
> > FOO_BASE.NAME
> > FOO_BASE.BASE_NAME
>
> Another isadvantage is that those variables are not valid shell
> variables, so we ca=ould no longer use constructs like:
>
> eval $(make -s printvars VARS=FOO.BASE_NAME)
>
> or similar...
>
> But this is also an advantage, in that those variable won't accidentally
> leak into the environment of _CMDS...
>
> But the disadvantage is more critical.
>
An alternative that was mentioned which solves that issue is separating package
name from the rest by a double underscore, i.e.
FOO__NAME
FOO__BASE_NAME
FOO__RAW_BASE_NAME
This would still be acceptable by the shell.
^ permalink raw reply [flat|nested] 7+ messages in thread
* [Buildroot] [PATCH 1/1] core: rename FOO_BASE_NAME to FOO_BASENAME to avoid clashes
2018-02-06 10:13 ` Thomas De Schampheleire
@ 2018-02-06 12:41 ` Arnout Vandecappelle
0 siblings, 0 replies; 7+ messages in thread
From: Arnout Vandecappelle @ 2018-02-06 12:41 UTC (permalink / raw)
To: buildroot
On 06-02-18 11:13, Thomas De Schampheleire wrote:
> On Mon, Feb 05, 2018 at 03:54:50PM +0100, Yann E. MORIN wrote:
>> Thomas, All,
>>
>> Quick review before in-depth review and testing...
>>
>> On 2018-02-05 15:29 +0100, Thomas De Schampheleire spake thusly:
>>> In current Buildroot, clashes occur between the variables _NAME and
>>> _BASE_NAME for two packages called foo and foo-base, i.e.
>>>
>>> Package foo:
>>> FOO_NAME = foo
>>> FOO_BASE_NAME = foo-1.2.3
>>>
>>> Package foo-base:
>>> FOO_BASE_NAME = foo-base
>>> FOO_BASE_BASE_NAME = foo-base-4.5.6
>>>
>>> where variable FOO_BASE_NAME is clashing between these two packages.
>>>
>>> The problem is generic and can occur for a number of variables in Buildroot.
>>> One solution is to use a different separator than '_' to separate the
>>> package name from the rest of the variable name. For example:
>>> FOO_NAME could become FOO.NAME, FOO-NAME, or something else.
>>> Then, in the example we would have following non-clashing variables:
>>> FOO.NAME
>>> FOO.BASE_NAME
>>> FOO_BASE.NAME
>>> FOO_BASE.BASE_NAME
>>
>> Another isadvantage is that those variables are not valid shell
>> variables, so we ca=ould no longer use constructs like:
>>
>> eval $(make -s printvars VARS=FOO.BASE_NAME)
>>
>> or similar...
>>
>> But this is also an advantage, in that those variable won't accidentally
>> leak into the environment of _CMDS...
>>
>> But the disadvantage is more critical.
>
> Yes, we didn't think of that.
>
>>
>>> However, making that change for only this case means that the variable
>>> naming is no longer consistent. And making the change for all variables has
>>> a large impact, also on certain user scripts.
>>>
>>> For now, keep it simple, and rename FOO_BASE_NAME into FOO_BASENAME, so that
>>> the variables become:
>>> FOO_NAME
>>> FOO_BASENAME
>>> FOO_BASE_NAME
>>> FOO_BASE_BASENAME
>>
>> You're listing _NAME and _BASENAME, but are also changing _RAW_BASENAME.
>
> Yes, I thought it would have been odd to have
> FOO_BASENAME
> and
> FOO_RAW_BASE_NAME
>
> so I aligned RAW_BASENAME as well.
>
> This still exposes a problem with foo-raw, as Cam Hutchingson also mentioned,
> but this is not the only remaining problem.
>
> Renaming FOO_RAW_BASE_NAME into FOO_BASENAME_RAW solves that problem, because
> there is no internal variable 'FOO_RAW'.
>
> It still doesn't solve other possible variable clashes, like DL_DIR for 'foo'
> with DIR for 'foo-dl'. But as we said, doing the full fix has some disadvantages
> as well.
We have a list of other conflicts in the BR meeting report, would be nice to
include that list in the commit message for easy reference.
Regards,
Arnout
--
Arnout Vandecappelle arnout at mind be
Senior Embedded Software Architect +32-16-286500
Essensium/Mind http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint: 7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF
^ permalink raw reply [flat|nested] 7+ messages in thread
* [Buildroot] [PATCH 1/1] core: rename FOO_BASE_NAME to FOO_BASENAME to avoid clashes
2018-02-06 10:17 ` Thomas De Schampheleire
@ 2018-02-06 12:42 ` Arnout Vandecappelle
0 siblings, 0 replies; 7+ messages in thread
From: Arnout Vandecappelle @ 2018-02-06 12:42 UTC (permalink / raw)
To: buildroot
On 06-02-18 11:17, Thomas De Schampheleire wrote:
> On Mon, Feb 05, 2018 at 03:54:50PM +0100, Yann E. MORIN wrote:
>> Thomas, All,
>>
>> Quick review before in-depth review and testing...
>>
>> On 2018-02-05 15:29 +0100, Thomas De Schampheleire spake thusly:
>>> In current Buildroot, clashes occur between the variables _NAME and
>>> _BASE_NAME for two packages called foo and foo-base, i.e.
>>>
>>> Package foo:
>>> FOO_NAME = foo
>>> FOO_BASE_NAME = foo-1.2.3
>>>
>>> Package foo-base:
>>> FOO_BASE_NAME = foo-base
>>> FOO_BASE_BASE_NAME = foo-base-4.5.6
>>>
>>> where variable FOO_BASE_NAME is clashing between these two packages.
>>>
>>> The problem is generic and can occur for a number of variables in Buildroot.
>>> One solution is to use a different separator than '_' to separate the
>>> package name from the rest of the variable name. For example:
>>> FOO_NAME could become FOO.NAME, FOO-NAME, or something else.
>>> Then, in the example we would have following non-clashing variables:
>>> FOO.NAME
>>> FOO.BASE_NAME
>>> FOO_BASE.NAME
>>> FOO_BASE.BASE_NAME
>>
>> Another isadvantage is that those variables are not valid shell
>> variables, so we ca=ould no longer use constructs like:
>>
>> eval $(make -s printvars VARS=FOO.BASE_NAME)
>>
>> or similar...
>>
>> But this is also an advantage, in that those variable won't accidentally
>> leak into the environment of _CMDS...
>>
>> But the disadvantage is more critical.
>>
>
> An alternative that was mentioned which solves that issue is separating package
> name from the rest by a double underscore, i.e.
> FOO__NAME
> FOO__BASE_NAME
> FOO__RAW_BASE_NAME
>
> This would still be acceptable by the shell.
Maybe use that example in the commit message then.
Regards,
Arnout
--
Arnout Vandecappelle arnout at mind be
Senior Embedded Software Architect +32-16-286500
Essensium/Mind http://www.mind.be
G.Geenslaan 9, 3001 Leuven, Belgium BE 872 984 063 RPR Leuven
LinkedIn profile: http://www.linkedin.com/in/arnoutvandecappelle
GPG fingerprint: 7493 020B C7E3 8618 8DEC 222C 82EB F404 F9AC 0DDF
^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2018-02-06 12:42 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-02-05 14:29 [Buildroot] [PATCH 1/1] core: rename FOO_BASE_NAME to FOO_BASENAME to avoid clashes Thomas De Schampheleire
2018-02-05 14:54 ` Yann E. MORIN
2018-02-06 10:13 ` Thomas De Schampheleire
2018-02-06 12:41 ` Arnout Vandecappelle
2018-02-06 10:17 ` Thomas De Schampheleire
2018-02-06 12:42 ` Arnout Vandecappelle
2018-02-05 22:23 ` Cam Hutchison
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.