2 # SPDX-License-Identifier: GPL-2.0+
3 # Copyright 2019 Google LLC
7 Script to remove boards
10 rmboard.py <board_name>...
12 A single commit is created for each board removed.
14 Some boards may depend on files provided by another and this will cause
15 problems, generally the removal of files which should not be removed.
18 - Looking through the MAINTAINERS files which mention a board to find out
19 what files the board uses
20 - Looking through the Kconfig files which mention a board to find one that
21 needs to have material removed
23 Search for ## to update the commit message manually.
31 from patman import command
33 def rm_kconfig_include(path):
34 """Remove a path from Kconfig files
36 This function finds the given path in a 'source' statement in a Kconfig
37 file and removes that line from the file. This is needed because the path
38 is going to be removed, so any reference to it will cause a problem with
41 The changes are made locally and then added to the git staging area.
44 path: Path to search for and remove
46 cmd = ['git', 'grep', path]
47 stdout = command.run_pipe([cmd], capture=True, raise_on_error=False).stdout
50 fname = stdout.split(':')[0]
52 print("Fixing up '%s' to remove reference to '%s'" % (fname, path))
53 cmd = ['sed', '-i', '\|%s|d' % path, fname]
54 stdout = command.run_pipe([cmd], capture=True).stdout
56 cmd = ['git', 'add', fname]
57 stdout = command.run_pipe([cmd], capture=True).stdout
60 """Create a commit which removes a single board
62 This looks up the MAINTAINERS file to file files that need to be removed,
63 then removes pieces from the Kconfig files that mention the board.
67 board: Board name to remove
70 # Find all MAINTAINERS and Kconfig files which mention the board
71 cmd = ['git', 'grep', '-l', board]
72 stdout = command.run_pipe([cmd], capture=True).stdout
75 for line in stdout.splitlines():
77 if 'MAINTAINERS' in line:
78 if line not in maintain:
80 elif 'Kconfig' in line:
85 # Look through the MAINTAINERS file to find things to remove
86 for fname in maintain:
87 with open(fname) as fd:
90 fields = re.split('[ \t]', line, 1)
94 elif fields[0] == 'F:':
95 paths.append(fields[1].strip())
97 # Expand any wildcards in the MAINTAINERS file
103 globbed = glob.glob(path)
104 print("Expanded '%s' to '%s'" % (path, globbed))
109 # Search for Kconfig files in the resulting list. Remove any 'source' lines
110 # which reference Kconfig files we want to remove
113 stdout = (command.run_pipe([cmd], capture=True, raise_on_error=False).
115 for fname in stdout.splitlines():
116 if fname.endswith('Kconfig'):
117 rm_kconfig_include(fname)
119 # Remove unwanted files
120 cmd = ['git', 'rm', '-r'] + real
121 stdout = command.run_pipe([cmd], capture=True).stdout
123 ## Change the messages as needed
124 msg = '''arm: Remove %s board
126 This board has not been converted to CONFIG_DM_MMC by the deadline.
131 msg += 'Patch-cc: %s\n' % name
134 cmd = ['git', 'commit', '-s', '-m', msg]
135 stdout = command.run_pipe([cmd], capture=True).stdout
137 # Check if the board is mentioned anywhere else. The user will need to deal
139 cmd = ['git', 'grep', '-il', board]
140 print(command.run_pipe([cmd], capture=True, raise_on_error=False).stdout)
143 for board in sys.argv[1:]: