Skip to contentSkip to conversation

make: add install-stripped target

PATCH RESEND In review Bagas Sanjaya 2 participants 4 messages Aug 31, 2021 – Sep 1, 2021 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH RESEND v2 1/1 make: add install-stripped target

Add the target that install Git with stripped executables.

install and install-stripped share the almost-same recipe, with the difference only on extra arguments to $(INSTALL). In order for this to work properly, installing all programs ($(ALL_PROGRAMS) and $(install_bindir_programs)) must be splitted into separate portions for compiled programs and scripts. For the former, add $(INSTALL_OPTS) and for the latter, don't add anything.

$(INSTALL_OPTS) contains stripping options that are passed from install-stripped.

---

Changes from v1:
- Share recipes between install-stripped and install targets (suggested by Junio)
- Don't delete 'strip' target. There may exist scripts that depend on that target. Once this patch is integrated, deprecation notice can be displayed when running the target, but it is done in separate patch.

 Makefile | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)
Makefile +14 -4
index d1feab008f..28d1e9bfae 100644
@@ -3004,7 +3004,8 @@ mergetools_instdir = $(prefix)/$(mergetoolsdir)
 endif
 mergetools_instdir_SQ = $(subst ','\'',$(mergetools_instdir))
 
-install_bindir_programs := $(patsubst %,%$X,$(BINDIR_PROGRAMS_NEED_X)) $(BINDIR_PROGRAMS_NO_X)
+install_bindir_xprograms := $(patsubst %,%$X,$(BINDIR_PROGRAMS_NEED_X))
+install_bindir_programs := $(install_bindir_xprograms) $(BINDIR_PROGRAMS_NO_X)
 
 .PHONY: profile-install profile-fast-install
 profile-install: profile
@@ -3013,12 +3014,21 @@ profile-install: profile
 profile-fast-install: profile-fast
 	$(MAKE) install
 
-install: all
+INSTALL_OPTS =
+
+.PHONY: install-stripped
+
+install-stripped: INSTALL_OPTS = -s --strip-program=$(STRIP)
+
+install-stripped install: all
 	$(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(bindir_SQ)'
 	$(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(gitexec_instdir_SQ)'
-	$(INSTALL) $(ALL_PROGRAMS) '$(DESTDIR_SQ)$(gitexec_instdir_SQ)'
+	$(INSTALL) $(INSTALL_OPTS) $(PROGRAMS) '$(DESTDIR_SQ)$(gitexec_instdir_SQ)'
+	$(INSTALL) $(SCRIPTS) '$(DESTDIR_SQ)$(gitexec_instdir_SQ)'
 	$(INSTALL) -m 644 $(SCRIPT_LIB) '$(DESTDIR_SQ)$(gitexec_instdir_SQ)'
-	$(INSTALL) $(install_bindir_programs) '$(DESTDIR_SQ)$(bindir_SQ)'
+	$(INSTALL) $(INSTALL_OPTS) $(install_bindir_xprograms) '$(DESTDIR_SQ)$(bindir_SQ)'
+	$(INSTALL) $(BINDIR_PROGRAMS_NO_X) '$(DESTDIR_SQ)$(bindir_SQ)'
+
 ifdef MSVC
 	# We DO NOT install the individual foo.o.pdb files because they
 	# have already been rolled up into the exe's pdb file.

base-commit: c4203212e360b25a1c69467b5a8437d45a373cac

Signature · 1 line
2.25.1
#1 lore raw

Review

Quoted 4 lines · Bagas Sanjaya

Add the target that install Git with stripped executables.
...

(quoted diff) +2 -0
+
+install-stripped: INSTALL_OPTS = -s --strip-program=$(STRIP)

Not everybody's $(INSTALL) supports --strip-program, does it?

FreeBSD seems to lack the option, and instead uses the $STRIPBIN environment variable to specify which program to use.

The manual page for macOS [*] does not mention --strip-program or STRIPBIN.

If the user leaves STRIP as the default (i.e. strip), this target fails, not because the user does not have 'strip', but because the 'install' used by the user does not know the --strip-program option, even though there is no need to use the option in such a case.

Given that, I am not sure if we really want "install-stripped" target. Adding INSTALL_OPTS make variable that defaults to an empty string is a good idea, but we probably can and should stop there.

Then users can do any of the following:

	$ make INSTALL_OPTS=-s install
	$ STRIPBIN=my-strip make INSTALL_OPTS=-s install

depending on their system, which sounds sufficient, and is a vast improvement over the current

	$ make ; make strip ; make install 

I would think.

[Reference]

* https://opensource.apple.com/source/file_cmds/file_cmds-321.40.3/install/install.1.auto.html

#2 lore raw
Quoted 8 lines · Junio C Hamano

Given that, I am not sure if we really want "install-stripped" target. Adding INSTALL_OPTS make variable that defaults to an empty string is a good idea, but we probably can and should stop there.

Then users can do any of the following:

	$ make INSTALL_OPTS=-s install
Quoted 8 lines
	$ STRIPBIN=my-strip make INSTALL_OPTS=-s install

depending on their system, which sounds sufficient, and is a vast improvement over the current

	$ make ; make strip ; make install

I would think.

If we make $(INSTALL_OPTS) applies to both compiled executables and scripts, we have problem that $(INSTALL) -s only works for the former.

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#3 lore raw
Quoted 2 lines · Bagas Sanjaya

If we make $(INSTALL_OPTS) applies to both compiled executables and scripts, we have problem that $(INSTALL) -s only works for the former.

Then don't make it apply to both ;-)

Isn't that what your patch did for early part of the install target? $(PROGRAMS) are installed with $(INSTALL_OPTS) while the invocation of $(INSTALL) for $(SCRIPTS) lack $(INSTALL_OPTS).

If we were to pursue this further, it probably is a good idea to rename the $(INSTALL_OPTS) to $(INSTALL_STRIP) to avoid complaints by confused users.

Something like this squashed into your patch, perhaps.

 Makefile | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)
Makefile +7 -8
index 28d1e9bfae..ebef4da50c 100644
@@ -465,6 +465,9 @@ all::
 # the global variable _wpgmptr containing the absolute path of the current
 # executable (this is the case on Windows).
 #
+# INSTALL_STRIP can be set to "-s" to strip binaries during installation,
+# if your $(INSTALL) command supports the option.
+#
 # Define GENERATE_COMPILATION_DATABASE to "yes" to generate JSON compilation
 # database entries during compilation if your compiler supports it, using the
 # `-MJ` flag. The JSON entries will be placed in the `compile_commands/`
@@ -3014,19 +3017,15 @@ profile-install: profile
 profile-fast-install: profile-fast
 	$(MAKE) install
 
-INSTALL_OPTS =
-
-.PHONY: install-stripped
-
-install-stripped: INSTALL_OPTS = -s --strip-program=$(STRIP)
+INSTALL_STRIP =
 
-install-stripped install: all
+install: all
 	$(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(bindir_SQ)'
 	$(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(gitexec_instdir_SQ)'
-	$(INSTALL) $(INSTALL_OPTS) $(PROGRAMS) '$(DESTDIR_SQ)$(gitexec_instdir_SQ)'
+	$(INSTALL) $(INSTALL_STRIP) $(PROGRAMS) '$(DESTDIR_SQ)$(gitexec_instdir_SQ)'
 	$(INSTALL) $(SCRIPTS) '$(DESTDIR_SQ)$(gitexec_instdir_SQ)'
 	$(INSTALL) -m 644 $(SCRIPT_LIB) '$(DESTDIR_SQ)$(gitexec_instdir_SQ)'
-	$(INSTALL) $(INSTALL_OPTS) $(install_bindir_xprograms) '$(DESTDIR_SQ)$(bindir_SQ)'
+	$(INSTALL) $(INSTALL_STRIP) $(install_bindir_xprograms) '$(DESTDIR_SQ)$(bindir_SQ)'
 	$(INSTALL) $(BINDIR_PROGRAMS_NO_X) '$(DESTDIR_SQ)$(bindir_SQ)'
 
 ifdef MSVC