Skip to contentSkip to conversation

kbuild: binrpm-pkg: Propagate O= to rpmbuild

PATCH In review Jeffrey Hugo 2 participants 3 messages Sep 20, 2019 – Sep 22, 2019 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kbuild: binrpm-pkg: Propagate O= to rpmbuild

If the user specifies O= to indicate a specific output directory for the build, rpmbuild does not honor this, and will use its default, which could be the user's home directory. In cases where the user has limited home directory space, this could cause the build to outright fail.

In the case of the binrpm-pkg target, redefine the top directory for output to be what the user specified in O=, thus the user will find a "rpmbuild" subdirectory in that location with all of the RPM artifacts.

This does not apply to rpm-pkg, since we already cannot handle creating the source tarball out of tree.

---
 scripts/Makefile.package | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)
scripts/Makefile.package +9 -3
index 56eadcc..aab0711 100644
@@ -21,7 +21,7 @@ include $(srctree)/scripts/Kbuild.include
 # - Use /. to avoid tar packing just the symlink
 
 # Note that the rpm-pkg target cannot be used with KBUILD_OUTPUT,
-# but the binrpm-pkg target can; for some reason O= gets ignored.
+# but the binrpm-pkg target can
 
 # Remove hyphens since they have special meaning in RPM filenames
 KERNELPATH := kernel-$(subst -,_,$(KERNELRELEASE))
@@ -33,6 +33,12 @@ TAR_CONTENT := $(KBUILD_ALLDIRS) .config .scmversion Makefile \
                Kbuild Kconfig COPYING $(wildcard localversion*)
 MKSPEC     := $(srctree)/scripts/package/mkspec
 
+RPM_OUTDIR :=
+ifneq ($(objtree),$(srctree))
+# Using absolute path as relative path will cause parts of rpmbuild to fail
+        RPM_OUTDIR := --define "_topdir $(abs_objtree)/rpmbuild"
+endif
+
 quiet_cmd_src_tar = TAR     $(2).tar.gz
       cmd_src_tar = \
 if test "$(objtree)" != "$(srctree)"; then \
@@ -65,8 +71,8 @@ PHONY += binrpm-pkg
 binrpm-pkg:
 	$(MAKE) -f $(srctree)/Makefile
 	$(CONFIG_SHELL) $(MKSPEC) prebuilt > $(objtree)/binkernel.spec
-	+rpmbuild $(RPMOPTS) --define "_builddir $(objtree)" --target \
-		$(UTS_MACHINE) -bb $(objtree)/binkernel.spec
+	+rpmbuild $(RPMOPTS) --define "_builddir $(objtree)" $(RPM_OUTDIR) \
+		--target $(UTS_MACHINE) -bb $(objtree)/binkernel.spec
 
 PHONY += deb-pkg
 deb-pkg:
Signature · 2 lines
Qualcomm Technologies, Inc. is a member of the
Code Aurora Forum, a Linux Foundation Collaborative Project.
#1 lore raw

Hi Jeffrey,

Quoted 6 lines · Jeffrey Hugo

If the user specifies O= to indicate a specific output directory for the build, rpmbuild does not honor this, and will use its default, which could be the user's home directory. In cases where the user has limited home directory space, this could cause the build to outright fail.

Quoted 8 lines

In the case of the binrpm-pkg target, redefine the top directory for output to be what the user specified in O=, thus the user will find a "rpmbuild" subdirectory in that location with all of the RPM artifacts.

This does not apply to rpm-pkg, since we already cannot handle creating the source tarball out of tree.

binrpm-pkg creates intermediate build artifacts in $(objtree)/, but puts only the final .rpm into ${HOME}/rpmbuild/RPMS/${ARCH}/.

It has worked like that since a long time before probably in order to respect the default of rpmbuild.

If you change this behavior, it should be consistent. The 'rpmbuild' should be always located in the kernel tree instead of the user's home directory.

But, doing so might give impact to other users who rely on having 'rpmbuild' in the home directory. I have to hear opinions from others
if this change is desired.

Meanwhile, if you are unhappy with that, one solution is to use RPMOPTS. RPMOPTS exists to tweak the default behavior.

Thanks.

Quoted 42 lines
---
 scripts/Makefile.package | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)
scripts/Makefile.package +9 -4
index 56eadcc..aab0711 100644
@@ -21,7 +21,7 @@ include $(srctree)/scripts/Kbuild.include
 # - Use /. to avoid tar packing just the symlink
 
 # Note that the rpm-pkg target cannot be used with KBUILD_OUTPUT,
-# but the binrpm-pkg target can; for some reason O= gets ignored.
+# but the binrpm-pkg target can
 
 # Remove hyphens since they have special meaning in RPM filenames
 KERNELPATH := kernel-$(subst -,_,$(KERNELRELEASE))
@@ -33,6 +33,12 @@ TAR_CONTENT := $(KBUILD_ALLDIRS) .config .scmversion Makefile \
                Kbuild Kconfig COPYING $(wildcard localversion*)
 MKSPEC     := $(srctree)/scripts/package/mkspec
 
+RPM_OUTDIR :=
+ifneq ($(objtree),$(srctree))
+# Using absolute path as relative path will cause parts of rpmbuild to fail
+        RPM_OUTDIR := --define "_topdir $(abs_objtree)/rpmbuild"
+endif
+
 quiet_cmd_src_tar = TAR     $(2).tar.gz
       cmd_src_tar = \
 if test "$(objtree)" != "$(srctree)"; then \
@@ -65,8 +71,8 @@ PHONY += binrpm-pkg
 binrpm-pkg:
        $(MAKE) -f $(srctree)/Makefile
        $(CONFIG_SHELL) $(MKSPEC) prebuilt > $(objtree)/binkernel.spec
-       +rpmbuild $(RPMOPTS) --define "_builddir $(objtree)" --target \
-               $(UTS_MACHINE) -bb $(objtree)/binkernel.spec
+       +rpmbuild $(RPMOPTS) --define "_builddir $(objtree)" $(RPM_OUTDIR) \
+               --target $(UTS_MACHINE) -bb $(objtree)/binkernel.spec
 
 PHONY += deb-pkg
 deb-pkg:
--
Quoted 3 lines

Qualcomm Technologies, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project.

--
Best Regards
Masahiro Yamada

#2 lore raw
Quoted 13 lines · Masahiro Yamada

Hi Jeffrey,

Quoted 10 lines · Jeffrey Hugo

If the user specifies O= to indicate a specific output directory for the build, rpmbuild does not honor this, and will use its default, which could be the user's home directory. In cases where the user has limited home directory space, this could cause the build to outright fail.

In the case of the binrpm-pkg target, redefine the top directory for output to be what the user specified in O=, thus the user will find a "rpmbuild" subdirectory in that location with all of the RPM artifacts.

Quoted 8 lines
Quoted 4 lines

This does not apply to rpm-pkg, since we already cannot handle creating the source tarball out of tree.

binrpm-pkg creates intermediate build artifacts in $(objtree)/, but puts only the final .rpm into ${HOME}/rpmbuild/RPMS/${ARCH}/.

I disagree with this. Ubuntu 16.04 with the 4.12 version of the rpm packaging utilities will create several directories under rpmbuild in the user's home directory - BUILDROOT RPMS SOURCES SPECS SRPMS

SOURCES/SPECS/SRPMS are empty for binrpm-pkg.
RPMs contains the final RPMs as you've indicated
BUILDROOT appears to contain more intermediate files which are used to then generate the final rpms.

It seems like more than just the final rpms are dumped into the home directory.

Quoted 3 lines

It has worked like that since a long time before probably in order to respect the default of rpmbuild.

It still seems inconsistent to me that there is an option defined (KBUILD_OUTPUT and O=) which is described to allow the user to specify the location of the build output, yet there are parts of the build system which do not respect this.

I also find it curious that there is a comment in the makefile this patch modifies that seems to suggest that it is intended for O= to impact the binrpm-pkg target, however that is currently not the case.

Quoted 5 lines

If you change this behavior, it should be consistent. The 'rpmbuild' should be always located in the kernel tree instead of the user's home directory.

I'm ok with this. The current patch attempts to preserve current behavior in the default case of not specifying an output directory, but dumping everything in the kernel tree seems sane to me.

Quoted 5 lines

But, doing so might give impact to other users who rely on having 'rpmbuild' in the home directory. I have to hear opinions from others
if this change is desired.

Fair enough.

Quoted 3 lines

Meanwhile, if you are unhappy with that, one solution is to use RPMOPTS. RPMOPTS exists to tweak the default behavior.

I don't see this documented anywhere. I'm assuming that is supposed to be an environment variable. I'll have to see how well that works with our automated build systems. Command line options are generally preferred.

Quoted 56 lines

Thanks.

Quoted 42 lines
---
  scripts/Makefile.package | 12 +++++++++---
  1 file changed, 9 insertions(+), 3 deletions(-)
scripts/Makefile.package +9 -4
index 56eadcc..aab0711 100644
@@ -21,7 +21,7 @@ include $(srctree)/scripts/Kbuild.include
  # - Use /. to avoid tar packing just the symlink
 
  # Note that the rpm-pkg target cannot be used with KBUILD_OUTPUT,
-# but the binrpm-pkg target can; for some reason O= gets ignored.
+# but the binrpm-pkg target can
 
  # Remove hyphens since they have special meaning in RPM filenames
  KERNELPATH := kernel-$(subst -,_,$(KERNELRELEASE))
@@ -33,6 +33,12 @@ TAR_CONTENT := $(KBUILD_ALLDIRS) .config .scmversion Makefile \
                 Kbuild Kconfig COPYING $(wildcard localversion*)
  MKSPEC     := $(srctree)/scripts/package/mkspec
 
+RPM_OUTDIR :=
+ifneq ($(objtree),$(srctree))
+# Using absolute path as relative path will cause parts of rpmbuild to fail
+        RPM_OUTDIR := --define "_topdir $(abs_objtree)/rpmbuild"
+endif
+
  quiet_cmd_src_tar = TAR     $(2).tar.gz
        cmd_src_tar = \
  if test "$(objtree)" != "$(srctree)"; then \
@@ -65,8 +71,8 @@ PHONY += binrpm-pkg
  binrpm-pkg:
         $(MAKE) -f $(srctree)/Makefile
         $(CONFIG_SHELL) $(MKSPEC) prebuilt > $(objtree)/binkernel.spec
-       +rpmbuild $(RPMOPTS) --define "_builddir $(objtree)" --target \
-               $(UTS_MACHINE) -bb $(objtree)/binkernel.spec
+       +rpmbuild $(RPMOPTS) --define "_builddir $(objtree)" $(RPM_OUTDIR) \
+               --target $(UTS_MACHINE) -bb $(objtree)/binkernel.spec
 
  PHONY += deb-pkg
  deb-pkg:
--
Quoted 3 lines

Qualcomm Technologies, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project.

--
Best Regards
Masahiro Yamada

Signature · 3 lines
Jeffrey Hugo
Qualcomm Technologies, Inc. is a member of the
Code Aurora Forum, a Linux Foundation Collaborative Project.