Commit f88f211b authored by Fabio Baltieri's avatar Fabio Baltieri Committed by Carles Cufi
Browse files

scripts: ci: check_compliance: improve the "not sorted" command 

Add a message to the KeepSorted error message with a oneline command to
sort the block failing the check.

Looks something like:

KeepSorted:sorted block is not sorted, sort by running:
"ex -s -c '14,757 sort i|x' dts/bindings/vendor-prefixes.txt"

Signed-off-by: default avatarFabio Baltieri <fabiobaltieri@google.com>
parent b21a455d

scripts/ci/check_compliance.py

+6 −1
Changes for scripts/ci/check_compliance.py: 6 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -1417,6 +1417,8 @@ class KeepSorted(ComplianceTest): 


        start_marker = f"{self.MARKER}-start"

        stop_marker = f"{self.MARKER}-stop"

        start_line = None

        stop_line = None



        for line_num, line in enumerate(fp.readlines(), start=1):

            if start_marker in line:
@@ -1426,15 +1428,18 @@ class KeepSorted(ComplianceTest): 
                                     desc=desc)

                in_block = True

                block_data = ""

                start_line = line_num + 1

            elif stop_marker in line:

                if not in_block:

                    desc = f"{stop_marker} without {start_marker}"

                    self.fmtd_failure("error", "KeepSorted", file, line_num,

                                     desc=desc)

                in_block = False

                stop_line = line_num - 1



                if not self.block_is_sorted(block_data):

                    desc = f"sorted block is not sorted"

                    desc = (f"sorted block is not sorted, sort by running: " +

                            f"\"ex -s -c '{start_line},{stop_line} sort i|x' {file}\"")

                    self.fmtd_failure("error", "KeepSorted", file, line_num,

                                      desc=desc)

            elif not line.strip() or line.startswith("#"):

CRA Git | Maintained and supported by SUSTech CRA and CCSE