Address minor test nits

Author: bd1976bris

cross-project-tests/dtlto/dtlto-translate-options.ll

@@ -8,8 +8,8 @@
 ; RUN: opt -thinlto-bc x86_64-pc-windows-msvc.ll   -o x86_64-pc-windows-msvc.bc
 
 
-;; Check that any invalid arguments would cause a Clang error. This property is
-;; relied on by the actual testcases later in this test.
+;; Check that invalid arguments cause a Clang error. This property is relied on
+;; by the actual testcases later in this test.
 ; RUN: not %clang -x ir x86_64-unknown-linux-gnu.ll \
 ; RUN:     -invalid-incorrect-not-an-option 2>&1 | FileCheck %s --check-prefix=SANITY1
 ; SANITY1: unknown argument: '-invalid-incorrect-not-an-option'
@@ -25,7 +25,7 @@
 ; DEFINE:   @%{triple}.rsp %{extra_flags}
 
 
-;; Write common arguments to a response files.
+;; Write common arguments to response files.
 
 ; RUN: echo "x86_64-unknown-linux-gnu.bc -o x86_64-unknown-linux-gnu.o \
 ; RUN:       -dtlto \
@@ -63,7 +63,7 @@
 ; RUN: %{command}
 ; REDEFINE: %{distributor} = validate.py
 ; RUN: not %{command} 2>&1 | FileCheck %s --check-prefix=ON \
-; RUN:     --implicit-check-not=-no-pgo-warn-mismatch
+; RUN:   --implicit-check-not=-no-pgo-warn-mismatch
 ; ON-DAG: "-faddrsig"
 ; ON-DAG: "-ffunction-sections"
 ; ON-DAG: "-fdata-sections"
@@ -80,7 +80,7 @@
 ; OFF-NOT: --implicit-check-not=-no-pgo-warn-mismatch
 
 
-;; Check optimisation level.
+;; Check optimization level.
 
 ; RUN: llvm-lto2 run \
 ; RUN:   -thinlto-distributor-arg=%llvm_src_root/utils/dtlto/local.py \
@@ -124,7 +124,6 @@
 
 
 ;--- x86_64-unknown-linux-gnu.ll
-
 target datalayout = "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128"
 target triple = "x86_64-unknown-linux-gnu"
 
@@ -134,7 +133,6 @@ entry:
 }
 
 ;--- x86_64-pc-windows-msvc.ll
-
 target datalayout = "e-m:w-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128"
 target triple = "x86_64-pc-windows-msvc"
 

llvm/utils/dtlto/local.py

@@ -1,11 +1,27 @@
+"""
+DTLTO local serial distributor.
+
+This script parses the Distributed ThinLTO (DTLTO) JSON file and serially
+executes the specified code generation tool on the local host to perform each 
+backend compilation job. This simple functional distributor is intended to be
+used for integration tests.
+
+Usage:
+    python dtlto_codegen.py <json_file>
+
+Arguments:
+    - <json_file> : JSON file describing the DTLTO jobs.
+"""
+
 import subprocess
 import sys
 import json
 from pathlib import Path
 
 if __name__ == "__main__":
     # Load the DTLTO information from the input JSON file.
-    data = json.loads(Path(sys.argv[-1]).read_bytes())
+    with Path(sys.argv[-1]).open() as f:
+        data = json.load(f)
 
     # Iterate over the jobs and execute the codegen tool.
     for job in data["jobs"]:

llvm/utils/dtlto/mock.py

@@ -1,3 +1,24 @@
+"""
+DTLTO Mock Distributor.
+
+This script acts as a mock distributor for Distributed ThinLTO (DTLTO). It is
+used for testing DTLTO when a Clang binary is not be available to invoke to
+perform the backend compilation jobs.
+
+Usage:
+    python mock_distributor.py <input_file1> <input_file2> ... <json_file>
+
+Arguments:
+    - <input_file1>, <input_file2>, ... : Input files to be copied.
+    - <json_file>                        : JSON file describing the DTLTO jobs.
+
+The script performs the following:
+    1. Reads the JSON file containing job descriptions.
+    2. For each job copies the corresponding input file to the output location
+       specified for that job.
+    3. Validates the JSON format using the `validate` module.
+"""
+
 import sys
 import json
 import shutil
@@ -9,7 +30,8 @@
     distributor_args = sys.argv[1:-1]
 
     # Load the DTLTO information from the input JSON file.
-    data = json.loads(Path(json_arg).read_bytes())
+    with Path(json_arg).open() as f:
+        data = json.load(f)
 
     # Iterate over the jobs and create the output
     # files by copying over the supplied input files.

llvm/utils/dtlto/validate.py

@@ -1,3 +1,22 @@
+"""
+DTLTO JSON Validator.
+
+This script is used for DTLTO testing to check that the distributor has
+been invoked correctly.
+
+Usage:
+    python validate.py <json_file>
+
+Arguments:
+    - <json_file> : JSON file describing the DTLTO jobs.
+
+The script does the following:
+    1. Prints the supplied CLI arguments.
+    2. Loads the JSON file.
+    3. Validates the structure and required fields.
+    4. Pretty prints the JSON.
+"""
+
 import sys
 import json
 from pathlib import Path
@@ -64,16 +83,17 @@ def validate_reference(a):
 
 
 if __name__ == "__main__":
-    json_arg = sys.argv[-1]
+    json_arg = Path(sys.argv[-1])
     distributor_args = sys.argv[1:-1]
 
     print(f"{distributor_args=}")
 
     # Load the DTLTO information from the input JSON file.
-    jdoc = json.loads(Path(json_arg).read_bytes())
+    with json_arg.open() as f:
+        jdoc = json.load(f)
 
     # Write the input JSON to stdout.
     print(json.dumps(jdoc, indent=4))
 
-    # Check the format of the JSON
+    # Check the format of the JSON.
     validate(jdoc)