[PATCH 1/2] kbuild: deb-pkg: use Debian compliant shebang for debian/rules

[PATCH 1/2] kbuild: deb-pkg: use Debian compliant shebang for debian/rules

[Masahiro Yamada]

Debian Policy "4.9. Main building script: debian/rules" requires
"debian/rules must start with the line #!/usr/bin/make -f". [1]

Currently, Kbuild does not follow this policy.

When Kbuild generates debian/rules, "#!$(command -v $MAKE) -f" is
expanded by shell. The result may not be "#!/usr/bin/make -f".

There was a reason to opt out the Debian policy.

If you run '/path/to/my/custom/make deb-pkg', debian/rules must also be
invoked by the same Make program. If #!/usr/bin/make were hard-coded in
debian/rules, the sub-make would be executed by a possibly different
Make version.

This is problematic due to the MAKEFLAGS incompatibility, especially the
job server flag. Old Make versions used --jobserver-fds to propagate job
server file descriptors, but Make >= 4.2 uses --jobserver-auth. The flag
disagreement between the parent and the child Make would result in a
process fork explosion.

However, having a non-standard path in the shebang causes another issue;
the generated source package is not portable as such a path does not
exist in other build environments.

This commit solves those conflicting demands.

Hard-code '#!/usr/bin/make -f' in debian/rules to create a portable and
Debian-compliant source package.

Pass '--rules-file=$(MAKE) -f debian/rules' when dpkg-buildpackage is
invoked from Makefile so that debian/rules is executed by the same Make
program as used to start Kbuild.

[1] https://www.debian.org/doc/debian-policy/ch-source.html#main-building-script-debian-rules

Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
---

 scripts/Makefile.package | 2 +-
 scripts/package/mkdebian | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/scripts/Makefile.package b/scripts/Makefile.package
index 85beab0363d7..f8a948ec2c6b 100644
--- a/scripts/Makefile.package
+++ b/scripts/Makefile.package
@@ -148,7 +148,7 @@ deb-pkg srcdeb-pkg bindeb-pkg:
 	$(if $(findstring source, $(build-type)), \
 		--unsigned-source --compression=$(KDEB_SOURCE_COMPRESS)) \
 	$(if $(findstring binary, $(build-type)), \
-		-r$(KBUILD_PKG_ROOTCMD) -a$$(cat debian/arch), \
+		--rules-file='$(MAKE) -f debian/rules' -r$(KBUILD_PKG_ROOTCMD) -a$$(cat debian/arch), \
 		--no-check-builddeps) \
 	$(DPKG_FLAGS))
 
diff --git a/scripts/package/mkdebian b/scripts/package/mkdebian
index 9105abab9728..2829f5b8aea6 100755
--- a/scripts/package/mkdebian
+++ b/scripts/package/mkdebian
@@ -264,7 +264,7 @@ EOF
 fi
 
 cat <<EOF > debian/rules
-#!$(command -v $MAKE) -f
+#!/usr/bin/make -f
 
 srctree ?= .
 KERNELRELEASE = ${KERNELRELEASE}
-- 
2.39.2

[PATCH 2/2] kbuild: deb-pkg: split debian/rules

[Masahiro Yamada]

debian/rules is generated by shell scripting, but the escape sequence
(\$) is unreadable.

debian/rules embeds only two variables (ARCH and KERNELRELEASE).

Split them out to debian/rules.vars, and check-in the rest of Makefile
code to scripts/package/debian/rules.

Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
---

 scripts/package/debian/rules | 28 ++++++++++++++++++++++++++++
 scripts/package/mkdebian     | 32 ++++----------------------------
 2 files changed, 32 insertions(+), 28 deletions(-)
 create mode 100755 scripts/package/debian/rules

diff --git a/scripts/package/debian/rules b/scripts/package/debian/rules
new file mode 100755
index 000000000000..a4e5ab5abdd9
--- /dev/null
+++ b/scripts/package/debian/rules
@@ -0,0 +1,28 @@
+#!/usr/bin/make -f
+# SPDX-License-Identifier: GPL-2.0-only
+
+srctree ?= .
+
+include debian/rules.vars
+
+.PHONY: binary binary-indep binary-arch
+binary: binary-arch binary-indep
+binary-indep: build-indep
+binary-arch: build-arch
+	$(MAKE) -f $(srctree)/Makefile ARCH=$(ARCH) \
+	KERNELRELEASE=$(KERNELRELEASE) \
+	run-command KBUILD_RUN_COMMAND=+$(srctree)/scripts/package/builddeb
+
+.PHONY: build build-indep build-arch
+build: build-arch build-indep
+build-indep:
+build-arch:
+	$(MAKE) -f $(srctree)/Makefile ARCH=$(ARCH) \
+	KERNELRELEASE=$(KERNELRELEASE) \
+	$(shell $(srctree)/scripts/package/deb-build-option) \
+	olddefconfig all
+
+.PHONY: clean
+clean:
+	rm -rf debian/files debian/linux-*
+	$(MAKE) -f $(srctree)/Makefile ARCH=${ARCH} clean
diff --git a/scripts/package/mkdebian b/scripts/package/mkdebian
index 2829f5b8aea6..498b579c6320 100755
--- a/scripts/package/mkdebian
+++ b/scripts/package/mkdebian
@@ -263,35 +263,11 @@ Description: Linux kernel debugging symbols for $version
 EOF
 fi
 
-cat <<EOF > debian/rules
-#!/usr/bin/make -f
-
-srctree ?= .
+cat <<EOF > debian/rules.vars
+ARCH = ${ARCH}
 KERNELRELEASE = ${KERNELRELEASE}
-
-.PHONY: clean build build-arch build-indep binary binary-arch binary-indep
-
-build-indep:
-build-arch:
-	\$(MAKE) -f \$(srctree)/Makefile ARCH=${ARCH} \
-	KERNELRELEASE=\$(KERNELRELEASE) \
-	\$(shell \$(srctree)/scripts/package/deb-build-option) \
-	olddefconfig all
-
-build: build-arch
-
-binary-indep:
-binary-arch: build-arch
-	\$(MAKE) -f \$(srctree)/Makefile ARCH=${ARCH} \
-	KERNELRELEASE=\$(KERNELRELEASE) \
-	run-command KBUILD_RUN_COMMAND=+\$(srctree)/scripts/package/builddeb
-
-clean:
-	rm -rf debian/files debian/linux-*
-	\$(MAKE) -f \$(srctree)/Makefile ARCH=${ARCH} clean
-
-binary: binary-arch
 EOF
-chmod +x debian/rules
+
+cp ${srctree}/scripts/package/debian/rules debian/
 
 exit 0
-- 
2.39.2

Re: [PATCH 1/2] kbuild: deb-pkg: use Debian compliant shebang for debian/rules

[Nicolas Schier]

[-- Attachment #1: Type: text/plain, Size: 3155 bytes --]

On Sat 29 Jul 2023 23:38:13 GMT, Masahiro Yamada wrote:
> Debian Policy "4.9. Main building script: debian/rules" requires
> "debian/rules must start with the line #!/usr/bin/make -f". [1]
> 
> Currently, Kbuild does not follow this policy.
> 
> When Kbuild generates debian/rules, "#!$(command -v $MAKE) -f" is
> expanded by shell. The result may not be "#!/usr/bin/make -f".
> 
> There was a reason to opt out the Debian policy.
> 
> If you run '/path/to/my/custom/make deb-pkg', debian/rules must also be
> invoked by the same Make program. If #!/usr/bin/make were hard-coded in
> debian/rules, the sub-make would be executed by a possibly different
> Make version.
> 
> This is problematic due to the MAKEFLAGS incompatibility, especially the
> job server flag. Old Make versions used --jobserver-fds to propagate job
> server file descriptors, but Make >= 4.2 uses --jobserver-auth. The flag
> disagreement between the parent and the child Make would result in a
> process fork explosion.
> 
> However, having a non-standard path in the shebang causes another issue;
> the generated source package is not portable as such a path does not
> exist in other build environments.
> 
> This commit solves those conflicting demands.
> 
> Hard-code '#!/usr/bin/make -f' in debian/rules to create a portable and
> Debian-compliant source package.
> 
> Pass '--rules-file=$(MAKE) -f debian/rules' when dpkg-buildpackage is
> invoked from Makefile so that debian/rules is executed by the same Make
> program as used to start Kbuild.
> 
> [1] https://www.debian.org/doc/debian-policy/ch-source.html#main-building-script-debian-rules
> 
> Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
> ---

LGTM, thanks!

Tested-by: Nicolas Schier <nicolas@fjasle.eu>
Reviewed-by: Nicolas Schier <nicolas@fjasle.eu>

> 
>  scripts/Makefile.package | 2 +-
>  scripts/package/mkdebian | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/scripts/Makefile.package b/scripts/Makefile.package
> index 85beab0363d7..f8a948ec2c6b 100644
> --- a/scripts/Makefile.package
> +++ b/scripts/Makefile.package
> @@ -148,7 +148,7 @@ deb-pkg srcdeb-pkg bindeb-pkg:
>  	$(if $(findstring source, $(build-type)), \
>  		--unsigned-source --compression=$(KDEB_SOURCE_COMPRESS)) \
>  	$(if $(findstring binary, $(build-type)), \
> -		-r$(KBUILD_PKG_ROOTCMD) -a$$(cat debian/arch), \
> +		--rules-file='$(MAKE) -f debian/rules' -r$(KBUILD_PKG_ROOTCMD) -a$$(cat debian/arch), \
>  		--no-check-builddeps) \
>  	$(DPKG_FLAGS))
>  
> diff --git a/scripts/package/mkdebian b/scripts/package/mkdebian
> index 9105abab9728..2829f5b8aea6 100755
> --- a/scripts/package/mkdebian
> +++ b/scripts/package/mkdebian
> @@ -264,7 +264,7 @@ EOF
>  fi
>  
>  cat <<EOF > debian/rules
> -#!$(command -v $MAKE) -f
> +#!/usr/bin/make -f
>  
>  srctree ?= .
>  KERNELRELEASE = ${KERNELRELEASE}
> -- 
> 2.39.2

-- 
Nicolas Schier
 
epost|xmpp: nicolas@fjasle.eu          irc://oftc.net/nsc
↳ gpg: 18ed 52db e34f 860e e9fb  c82b 7d97 0932 55a0 ce7f
     -- frykten for herren er opphav til kunnskap --

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH 2/2] kbuild: deb-pkg: split debian/rules

[Nicolas Schier]

[-- Attachment #1: Type: text/plain, Size: 3335 bytes --]

On Sat 29 Jul 2023 23:38:14 GMT, Masahiro Yamada wrote:
> debian/rules is generated by shell scripting, but the escape sequence
> (\$) is unreadable.
> 
> debian/rules embeds only two variables (ARCH and KERNELRELEASE).
> 
> Split them out to debian/rules.vars, and check-in the rest of Makefile
> code to scripts/package/debian/rules.
> 
> Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
> ---
> 
>  scripts/package/debian/rules | 28 ++++++++++++++++++++++++++++
>  scripts/package/mkdebian     | 32 ++++----------------------------
>  2 files changed, 32 insertions(+), 28 deletions(-)
>  create mode 100755 scripts/package/debian/rules
> 
> diff --git a/scripts/package/debian/rules b/scripts/package/debian/rules
> new file mode 100755
> index 000000000000..a4e5ab5abdd9
> --- /dev/null
> +++ b/scripts/package/debian/rules
> @@ -0,0 +1,28 @@
> +#!/usr/bin/make -f
> +# SPDX-License-Identifier: GPL-2.0-only
> +
> +srctree ?= .
> +
> +include debian/rules.vars
> +
> +.PHONY: binary binary-indep binary-arch
> +binary: binary-arch binary-indep
> +binary-indep: build-indep
> +binary-arch: build-arch
> +	$(MAKE) -f $(srctree)/Makefile ARCH=$(ARCH) \
> +	KERNELRELEASE=$(KERNELRELEASE) \
> +	run-command KBUILD_RUN_COMMAND=+$(srctree)/scripts/package/builddeb
> +
> +.PHONY: build build-indep build-arch
> +build: build-arch build-indep
> +build-indep:
> +build-arch:
> +	$(MAKE) -f $(srctree)/Makefile ARCH=$(ARCH) \
> +	KERNELRELEASE=$(KERNELRELEASE) \
> +	$(shell $(srctree)/scripts/package/deb-build-option) \
> +	olddefconfig all
> +
> +.PHONY: clean
> +clean:
> +	rm -rf debian/files debian/linux-*
> +	$(MAKE) -f $(srctree)/Makefile ARCH=${ARCH} clean

possibly use '$(ARCH)' instead of '${ARCH}' here, too?


Tested-by: Nicolas Schier <nicolas@fjasle.eu>
Reviewed-by: Nicolas Schier <nicolas@fjasle.eu>

> diff --git a/scripts/package/mkdebian b/scripts/package/mkdebian
> index 2829f5b8aea6..498b579c6320 100755
> --- a/scripts/package/mkdebian
> +++ b/scripts/package/mkdebian
> @@ -263,35 +263,11 @@ Description: Linux kernel debugging symbols for $version
>  EOF
>  fi
>  
> -cat <<EOF > debian/rules
> -#!/usr/bin/make -f
> -
> -srctree ?= .
> +cat <<EOF > debian/rules.vars
> +ARCH = ${ARCH}
>  KERNELRELEASE = ${KERNELRELEASE}
> -
> -.PHONY: clean build build-arch build-indep binary binary-arch binary-indep
> -
> -build-indep:
> -build-arch:
> -	\$(MAKE) -f \$(srctree)/Makefile ARCH=${ARCH} \
> -	KERNELRELEASE=\$(KERNELRELEASE) \
> -	\$(shell \$(srctree)/scripts/package/deb-build-option) \
> -	olddefconfig all
> -
> -build: build-arch
> -
> -binary-indep:
> -binary-arch: build-arch
> -	\$(MAKE) -f \$(srctree)/Makefile ARCH=${ARCH} \
> -	KERNELRELEASE=\$(KERNELRELEASE) \
> -	run-command KBUILD_RUN_COMMAND=+\$(srctree)/scripts/package/builddeb
> -
> -clean:
> -	rm -rf debian/files debian/linux-*
> -	\$(MAKE) -f \$(srctree)/Makefile ARCH=${ARCH} clean
> -
> -binary: binary-arch
>  EOF
> -chmod +x debian/rules
> +
> +cp ${srctree}/scripts/package/debian/rules debian/
>  
>  exit 0
> -- 
> 2.39.2

-- 
Nicolas Schier
 
epost|xmpp: nicolas@fjasle.eu          irc://oftc.net/nsc
↳ gpg: 18ed 52db e34f 860e e9fb  c82b 7d97 0932 55a0 ce7f
     -- frykten for herren er opphav til kunnskap --

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH 2/2] kbuild: deb-pkg: split debian/rules

[Masahiro Yamada]

On Sun, Jul 30, 2023 at 3:23 AM Nicolas Schier <nicolas@fjasle.eu> wrote:
>
> On Sat 29 Jul 2023 23:38:14 GMT, Masahiro Yamada wrote:
> > debian/rules is generated by shell scripting, but the escape sequence
> > (\$) is unreadable.
> >
> > debian/rules embeds only two variables (ARCH and KERNELRELEASE).
> >
> > Split them out to debian/rules.vars, and check-in the rest of Makefile
> > code to scripts/package/debian/rules.
> >
> > Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
> > ---
> >
> >  scripts/package/debian/rules | 28 ++++++++++++++++++++++++++++
> >  scripts/package/mkdebian     | 32 ++++----------------------------
> >  2 files changed, 32 insertions(+), 28 deletions(-)
> >  create mode 100755 scripts/package/debian/rules
> >
> > diff --git a/scripts/package/debian/rules b/scripts/package/debian/rules
> > new file mode 100755
> > index 000000000000..a4e5ab5abdd9
> > --- /dev/null
> > +++ b/scripts/package/debian/rules
> > @@ -0,0 +1,28 @@
> > +#!/usr/bin/make -f
> > +# SPDX-License-Identifier: GPL-2.0-only
> > +
> > +srctree ?= .
> > +
> > +include debian/rules.vars
> > +
> > +.PHONY: binary binary-indep binary-arch
> > +binary: binary-arch binary-indep
> > +binary-indep: build-indep
> > +binary-arch: build-arch
> > +     $(MAKE) -f $(srctree)/Makefile ARCH=$(ARCH) \
> > +     KERNELRELEASE=$(KERNELRELEASE) \
> > +     run-command KBUILD_RUN_COMMAND=+$(srctree)/scripts/package/builddeb
> > +
> > +.PHONY: build build-indep build-arch
> > +build: build-arch build-indep
> > +build-indep:
> > +build-arch:
> > +     $(MAKE) -f $(srctree)/Makefile ARCH=$(ARCH) \
> > +     KERNELRELEASE=$(KERNELRELEASE) \
> > +     $(shell $(srctree)/scripts/package/deb-build-option) \
> > +     olddefconfig all
> > +
> > +.PHONY: clean
> > +clean:
> > +     rm -rf debian/files debian/linux-*
> > +     $(MAKE) -f $(srctree)/Makefile ARCH=${ARCH} clean
>
> possibly use '$(ARCH)' instead of '${ARCH}' here, too?


Thanks, I will fix it in v2.




-- 
Best Regards
Masahiro Yamada