[mirror_ubuntu-jammy-kernel.git] / scripts / remove-stale-files

#!/bin/sh

set -e

# When you move, remove or rename generated files, you probably also update
# .gitignore and cleaning rules in the Makefile. This is the right thing
# to do. However, people usually do 'git pull', 'git bisect', etc. without
# running 'make clean'. Then, the stale generated files are left over, often
# causing build issues.
#
# Also, 'git status' shows such stale build artifacts as untracked files.
# What is worse, some people send a wrong patch to get them back to .gitignore
# without checking the commit history.
#
# So, when you (re)move generated files, please move the cleaning rules from
# the Makefile to this script. This is run before Kbuild starts building
# anything, so people will not be annoyed by such garbage files.
#
# This script is not intended to grow endlessly. Rather, it is a temporary scrap
# yard. Stale files stay in this file for a while (for some release cycles?),
# then will be really dead and removed from the code base entirely.

# These were previously generated source files. When you are building the kernel
# with O=, make sure to remove the stale files in the output tree. Otherwise,
# the build system wrongly compiles the stale ones.
if [ -n "${building_out_of_srctree}" ]; then
	for f in fdt_rw.c fdt_ro.c fdt_wip.c fdt.c
	do
		rm -f arch/arm/boot/compressed/${f}
	done
fi
Commit	Line	Data
1476fee5 MY	1	#!/bin/sh
	2
	3	set -e
	4
	5	# When you move, remove or rename generated files, you probably also update
	6	# .gitignore and cleaning rules in the Makefile. This is the right thing
	7	# to do. However, people usually do 'git pull', 'git bisect', etc. without
	8	# running 'make clean'. Then, the stale generated files are left over, often
	9	# causing build issues.
	10	#
	11	# Also, 'git status' shows such stale build artifacts as untracked files.
	12	# What is worse, some people send a wrong patch to get them back to .gitignore
	13	# without checking the commit history.
	14	#
	15	# So, when you (re)move generated files, please move the cleaning rules from
	16	# the Makefile to this script. This is run before Kbuild starts building
	17	# anything, so people will not be annoyed by such garbage files.
	18	#
	19	# This script is not intended to grow endlessly. Rather, it is a temporary scrap
	20	# yard. Stale files stay in this file for a while (for some release cycles?),
	21	# then will be really dead and removed from the code base entirely.
	22
	23	# These were previously generated source files. When you are building the kernel
	24	# with O=, make sure to remove the stale files in the output tree. Otherwise,
	25	# the build system wrongly compiles the stale ones.
	26	if [ -n "${building_out_of_srctree}" ]; then
	27	for f in fdt_rw.c fdt_ro.c fdt_wip.c fdt.c
	28	do
	29	rm -f arch/arm/boot/compressed/${f}
	30	done
	31	fi