kbuild: single-quote the format string of printf
PATCH 1/1 kbuild: single-quote the format string of printf
Use single-quotes to avoid escape sequences (\\n).
---
Makefile | 8 ++++---- arch/powerpc/Makefile | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-)
Makefile +4 -4
@@ -1643,12 +1643,12 @@ help: @echo '' @$(if $(boards), \ $(foreach b, $(boards), \ - printf " %-27s - Build for %s\\n" $(b) $(subst _defconfig,,$(b));) \ + printf ' %-27s - Build for %s\n' $(b) $(subst _defconfig,,$(b));) \ echo '') @$(if $(board-dirs), \ $(foreach b, $(board-dirs), \ - printf " %-16s - Show %s-specific targets\\n" help-$(b) $(b);) \ - printf " %-16s - Show all of the above\\n" help-boards; \ + printf ' %-16s - Show %s-specific targets\n' help-$(b) $(b);) \ + printf ' %-16s - Show all of the above\n' help-boards; \ echo '') @echo ' make V=n [targets] 1: verbose build'
@@ -1684,7 +1684,7 @@ $(help-board-dirs): help-%: @echo 'Architecture specific targets ($(SRCARCH) $*):' @$(if $(boards-per-dir), \ $(foreach b, $(boards-per-dir), \ - printf " %-24s - Build for %s\\n" $*/$(b) $(subst _defconfig,,$(b));) \ + printf ' %-24s - Build for %s\n' $*/$(b) $(subst _defconfig,,$(b));) \ echo '')
arch/powerpc/Makefile +1 -1
@@ -353,7 +353,7 @@ define archhelp echo ' (minus the .dts extension).' echo $(foreach cfg,$(generated_configs), - printf " %-27s - Build for %s\\n" $(cfg) $(subst _defconfig,,$(cfg));) + printf ' %-27s - Build for %s\n' $(cfg) $(subst _defconfig,,$(cfg));) endef PHONY += install
Signature · 1 line
2.39.2
Quoted 4 lines · Masahiro Yamada
Use single-quotes to avoid escape sequences (\\n).
Signed-off-by Masahiro Yamada <[email protected]>---
Is this really necessary? Testing w/ GNU Make 4.3, bash 5.2.15 or dash 0.5.12-6 and a stupid Makefile snippet I cannot see any difference between these three:
print:
@printf "hello med single-backslash and double quotes\n" @printf 'hello med single-backslash and single quotes\n' @printf "hello med double-backslash and double quotes\\n"
Only double-backslash+n in single-quotes does not work, for obvious reasons.
Is this some compatibility to older make versions or other shells?
Iff it is, we should have several cases that are actually broken right now:
$ git grep -Hrne 'printf.*".*\\n' '**/Makefile*' '**/Kbuild*'
arch/mips/Makefile:480: printf " %-24s - Build generic kernel for $(call describe_generic_defconfig,$(cfg))\n" $(cfg);)
arch/mips/Makefile:486: printf " %-24s - Build $($(cfg)-y)\n" $(cfg);)
samples/bpf/Makefile:238:HDR_PROBE := $(shell printf "$(pound)include <linux/types.h>\n struct list_head { int a; }; int main() { return 0; }" | \
samples/hid/Makefile:76:HDR_PROBE := $(shell printf "$(pound)include <linux/types.h>\n struct list_head { int a; }; int main() { return 0; }" | \
scripts/Makefile.compiler:41: printf "%b\n" "$(1)" | $(CC) -Werror $(CLANG_FLAGS) $(KBUILD_AFLAGS) -c -x assembler-with-cpp -o "$$TMP" -,$(2),$(3))
scripts/Makefile.lib:437:printf "%08x\n" $$dec_size | \
scripts/Makefile.modfinal:43: printf "Skipping BTF generation for %s due to unavailability of vmlinux\n" $@ 1>&2; \
scripts/Makefile.modfinal:45: printf "Skipping BTF generation for %s because it's a Rust module\n" $@ 1>&2; \
security/tomoyo/Makefile:11: printf '\t"";\n';) \
tools/testing/selftests/Makefile:263: [ ! -d $(INSTALL_PATH)/$$TARGET ] && printf "Skipping non-existent dir: $$TARGET\n" && continue; \
tools/testing/selftests/Makefile:264: printf "Emit Tests for $$TARGET\n"; \
tools/testing/selftests/nolibc/Makefile:136: if (s+f > 0) printf(" See all results in %s\n", ARGV[1]); else print; }' \
tools/testing/selftests/nolibc/Makefile:155: if (s+f > 0) printf(" See all results in %s\n", ARGV[1]); else print; }' \
tools/testing/selftests/nolibc/Makefile:163: if (s+f > 0) printf(" See all results in %s\n", ARGV[1]); else print; }' \
tools/testing/selftests/wireguard/qemu/Makefile:335: printf 'CONFIG_NR_CPUS=$(NR_CPUS)\nCONFIG_INITRAMFS_SOURCE="$(BUILD_PATH)/init-cpio-spec.txt"\n' >> $(KERNEL_BUILD_PATH)/minimal.configI assume, that changing '\\n' occurrences in all Makefiles to '\n' should be enough; but only a cosmetic change. Or did I miss some point?
Kind regards,
Nicolas
Quoted 49 lines
Makefile | 8 ++++---- arch/powerpc/Makefile | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-)Makefile +4
-4@@ -1643,12 +1643,12 @@ help: @echo '' @$(if $(boards), \ $(foreach b, $(boards), \ - printf " %-27s - Build for %s\\n" $(b) $(subst _defconfig,,$(b));) \ + printf ' %-27s - Build for %s\n' $(b) $(subst _defconfig,,$(b));) \ echo '') @$(if $(board-dirs), \ $(foreach b, $(board-dirs), \ - printf " %-16s - Show %s-specific targets\\n" help-$(b) $(b);) \ - printf " %-16s - Show all of the above\\n" help-boards; \ + printf ' %-16s - Show %s-specific targets\n' help-$(b) $(b);) \ + printf ' %-16s - Show all of the above\n' help-boards; \ echo '') @echo ' make V=n [targets] 1: verbose build'@@ -1684,7 +1684,7 @@ $(help-board-dirs): help-%: @echo 'Architecture specific targets ($(SRCARCH) $*):' @$(if $(boards-per-dir), \ $(foreach b, $(boards-per-dir), \ - printf " %-24s - Build for %s\\n" $*/$(b) $(subst _defconfig,,$(b));) \ + printf ' %-24s - Build for %s\n' $*/$(b) $(subst _defconfig,,$(b));) \ echo '')arch/powerpc/Makefile +1
-1@@ -353,7 +353,7 @@ define archhelp echo ' (minus the .dts extension).' echo $(foreach cfg,$(generated_configs), - printf " %-27s - Build for %s\\n" $(cfg) $(subst _defconfig,,$(cfg));) + printf ' %-27s - Build for %s\n' $(cfg) $(subst _defconfig,,$(cfg));) endef PHONY += installSignature · 1 line
2.39.2
Quoted 11 lines · Nicolas Schier
Quoted 4 lines · Masahiro Yamada
Use single-quotes to avoid escape sequences (\\n).
Signed-off-by Masahiro Yamada <[email protected]>---
Is this really necessary? Testing w/ GNU Make 4.3, bash 5.2.15 or dash 0.5.12-6 and a stupid
Makefilesnippet I cannot see any difference between these three:
Quoted 7 lines
print:
@printf "hello med single-backslash and double quotes\n" @printf 'hello med single-backslash and single quotes\n' @printf "hello med double-backslash and double quotes\\n"Only double-backslash+n in single-quotes does not work, for obvious reasons.
You are right.
I was misunderstanding the backslash-escaping in double-quotes.
I always used single-quotes when I wanted to avoid escape sequences.
The following POSIX spec applies here:
2.2.3 Double-Quotes
The <backslash> shall retain its special meaning as an escape character (see Escape Character (Backslash)) only when followed by one of the following characters when considered special:
$ ` " \ <newline>
https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html
All of "\\n", "\n", '\n' are the same.
Signature · 2 lines
Best Regards Masahiro Yamada
...
Quoted 1 line
All of "\\n", "\n", '\n' are the same.
and \\n (without any quote characters at all).
Personally I'd use 'format' for printf.
To make it obvious that nothing is to be expanded. But it isn't really worth changing existing 'stuff'.
David
-
Registered Address Lakeside, Bramley Road, Mount Farm, Milton Keynes, MK1 1PT, UK Registration No: 1397386 (Wales)