[llvm] 180625f - Add a breadcrumb comment to make debugging a user error when using ./utils/update_analyze_test_checks.py easier.

[Philip Reames via llvm-commits]

Author: Philip Reames
Date: 2021-11-18T09:07:19-08:00
New Revision: 180625fcb478877bfada337705ec4e2e1ecb8d7e

URL: https://github.com/llvm/llvm-project/commit/180625fcb478877bfada337705ec4e2e1ecb8d7e
DIFF: https://github.com/llvm/llvm-project/commit/180625fcb478877bfada337705ec4e2e1ecb8d7e.diff

LOG: Add a breadcrumb comment to make debugging a user error when using ./utils/update_analyze_test_checks.py easier.

We won't talk about how long it took me to figure this out.  The difference in batch vs interactive on the "did you mean to print bitcode" message made this confusing.

Added: 
    

Modified: 
    llvm/utils/UpdateTestChecks/common.py

Removed: 
    


################################################################################
diff  --git a/llvm/utils/UpdateTestChecks/common.py b/llvm/utils/UpdateTestChecks/common.py
index 5cb5eb473e288..cf8c8881c8513 100644
--- a/llvm/utils/UpdateTestChecks/common.py
+++ b/llvm/utils/UpdateTestChecks/common.py
@@ -182,6 +182,9 @@ def invoke_tool(exe, cmd_args, ir, preprocess_cmd=None, verbose=False):
       stdout = subprocess.check_output(exe + ' ' + applySubstitutions(cmd_args, substitutions),
                                        shell=True, stdin=ir_file)
     if sys.version_info[0] > 2:
+      # FYI, if you crashed here with a decode error, your run line probably
+      # results in bitcode or other binary format being written to the pipe.
+      # For an opt test, you probably want to add -S or -disable-output.
       stdout = stdout.decode()
   # Fix line endings to unix CR style.
   return stdout.replace('\r\n', '\n')