From: Simon Glass Date: Wed, 19 Jul 2023 23:48:30 +0000 (-0600) Subject: buildman: Convert camel case in control.py X-Git-Url: http://git.dujemihanovic.xyz/?a=commitdiff_plain;h=9ef05b950e47f4ca44bda7f0161180068ede0334;p=u-boot.git buildman: Convert camel case in control.py Convert this file to snake case and update all files which use it. Signed-off-by: Simon Glass --- diff --git a/tools/buildman/control.py b/tools/buildman/control.py index 89010eac3a..fac6c45fcd 100644 --- a/tools/buildman/control.py +++ b/tools/buildman/control.py @@ -2,6 +2,11 @@ # Copyright (c) 2013 The Chromium OS Authors. # +"""Control module for buildman + +This holds the main control logic for buildman, when not running tests. +""" + import multiprocessing try: import importlib.resources @@ -25,11 +30,11 @@ from u_boot_pylib import terminal from u_boot_pylib import tools from u_boot_pylib.terminal import tprint -def GetPlural(count): +def get_plural(count): """Returns a plural 's' if count is not 1""" return 's' if count != 1 else '' -def GetActionSummary(is_summary, commits, selected, options): +def get_action_summary(is_summary, commits, selected, options): """Return a string summarising the intended action. Returns: @@ -38,18 +43,18 @@ def GetActionSummary(is_summary, commits, selected, options): if commits: count = len(commits) count = (count + options.step - 1) // options.step - commit_str = '%d commit%s' % (count, GetPlural(count)) + commit_str = '%d commit%s' % (count, get_plural(count)) else: commit_str = 'current source' str = '%s %s for %d boards' % ( 'Summary of' if is_summary else 'Building', commit_str, len(selected)) str += ' (%d thread%s, %d job%s per thread)' % (options.threads, - GetPlural(options.threads), options.jobs, GetPlural(options.jobs)) + get_plural(options.threads), options.jobs, get_plural(options.jobs)) return str -def ShowActions(series, why_selected, boards_selected, builder, options, - board_warnings): +def show_actions(series, why_selected, boards_selected, builder, options, + board_warnings): """Display a list of actions that we would take, if not a dry run. Args: @@ -72,7 +77,7 @@ def ShowActions(series, why_selected, boards_selected, builder, options, commits = series.commits else: commits = None - print(GetActionSummary(False, commits, boards_selected, + print(get_action_summary(False, commits, boards_selected, options)) print('Build directory: %s' % builder.base_dir) if commits: @@ -92,7 +97,7 @@ def ShowActions(series, why_selected, boards_selected, builder, options, for warning in board_warnings: print(col.build(col.YELLOW, warning)) -def ShowToolchainPrefix(brds, toolchains): +def show_toolchain_prefix(brds, toolchains): """Show information about a the tool chain used by one or more boards The function checks that all boards use the same toolchain, then prints @@ -133,8 +138,8 @@ def get_allow_missing(opt_allow, opt_no_allow, num_selected, has_branch): allow_missing = False return allow_missing -def DoBuildman(options, args, toolchains=None, make_func=None, brds=None, - clean_dir=False, test_thread_exceptions=False): +def do_buildman(options, args, toolchains=None, make_func=None, brds=None, + clean_dir=False, test_thread_exceptions=False): """The main control code for buildman Args: @@ -246,7 +251,7 @@ def DoBuildman(options, args, toolchains=None, make_func=None, brds=None, sys.exit(col.build(col.RED, 'No matching boards found')) if options.print_prefix: - err = ShowToolchainPrefix(brds, toolchains) + err = show_toolchain_prefix(brds, toolchains) if err: sys.exit(col.build(col.RED, err)) return 0 @@ -382,7 +387,7 @@ def DoBuildman(options, args, toolchains=None, make_func=None, brds=None, # For a dry run, just show our actions as a sanity check if options.dry_run: - ShowActions(series, why_selected, selected, builder, options, + show_actions(series, why_selected, selected, builder, options, board_warnings) else: builder.force_build = options.force_build @@ -402,7 +407,7 @@ def DoBuildman(options, args, toolchains=None, make_func=None, brds=None, commits = None if not options.ide: - tprint(GetActionSummary(options.summary, commits, board_selected, + tprint(get_action_summary(options.summary, commits, board_selected, options)) # We can't show function sizes without board details at present diff --git a/tools/buildman/func_test.py b/tools/buildman/func_test.py index e6cdebdbd1..57d2ebce3a 100644 --- a/tools/buildman/func_test.py +++ b/tools/buildman/func_test.py @@ -255,9 +255,10 @@ class TestFunctional(unittest.TestCase): options, args = cmdline.ParseArgs() if brds == False: brds = self._boards - result = control.DoBuildman(options, args, toolchains=self._toolchains, - make_func=self._HandleMake, brds=brds, clean_dir=clean_dir, - test_thread_exceptions=test_thread_exceptions) + result = control.do_buildman( + options, args, toolchains=self._toolchains, + make_func=self._HandleMake, brds=brds, clean_dir=clean_dir, + test_thread_exceptions=test_thread_exceptions) if get_builder: self._builder = control.builder return result diff --git a/tools/buildman/main.py b/tools/buildman/main.py index 9b55125f74..d9ad836215 100755 --- a/tools/buildman/main.py +++ b/tools/buildman/main.py @@ -67,9 +67,8 @@ def run_buildman(): # Build selected commits for selected boards else: bsettings.Setup(options.config_file) - ret_code = control.DoBuildman(options, args) + ret_code = control.do_buildman(options, args) return ret_code - return 0 if __name__ == "__main__": diff --git a/tools/buildman/test.py b/tools/buildman/test.py index 9fa6445b79..7eb25aa80e 100644 --- a/tools/buildman/test.py +++ b/tools/buildman/test.py @@ -465,7 +465,7 @@ class TestBuild(unittest.TestCase): options.show_errors = False options.keep_outputs = False args = ['tegra20'] - control.DoBuildman(options, args) + control.do_buildman(options, args) def testBoardSingle(self): """Test single board selection"""