Skip to content

[BOLT][NFC] Update nfc-check-setup.py guidance #146659

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: users/paschalis-mpeis/nfc-check-improve-file-handling
Choose a base branch
from

Conversation

paschalis-mpeis
Copy link
Member

No description provided.

@paschalis-mpeis paschalis-mpeis marked this pull request as ready for review July 2, 2025 09:39
@llvmbot llvmbot added the BOLT label Jul 2, 2025
@llvmbot
Copy link
Member

llvmbot commented Jul 2, 2025

@llvm/pr-subscribers-bolt

Author: Paschalis Mpeis (paschalis-mpeis)

Changes

Full diff: https://github.com/llvm/llvm-project/pull/146659.diff

1 Files Affected:

  • (modified) bolt/utils/nfc-check-setup.py (+6-5)
diff --git a/bolt/utils/nfc-check-setup.py b/bolt/utils/nfc-check-setup.py
index 6cf1df5c177ae..87a134aea37ca 100755
--- a/bolt/utils/nfc-check-setup.py
+++ b/bolt/utils/nfc-check-setup.py
@@ -47,8 +47,10 @@ def main():
     parser = argparse.ArgumentParser(
         description=textwrap.dedent(
             """
-            This script builds two versions of BOLT (with the current and
-            previous revision).
+            This script builds two versions of BOLT:
+            llvm-bolt.new, using the current revision, and llvm-bolt.old using
+            the previous revision. These can be used to check whether the
+            current revision changes BOLT's functional behavior.
             """
         )
     )
@@ -156,9 +158,8 @@ def main():
     os.replace(bolt_path, f"{bolt_path}.old")
 
     print(
-        f"Build directory {args.build_dir} is ready to run BOLT tests, e.g.\n"
-        "\tbin/llvm-lit -sv tools/bolt/test\nor\n"
-        "\tbin/llvm-lit -sv tools/bolttests"
+        f"Build directory {args.build_dir} is ready for NFC-Mode comparison "
+        "between the two revisions."
     )
 
 

"\tbin/llvm-lit -sv tools/bolt/test\nor\n"
"\tbin/llvm-lit -sv tools/bolttests"
f"Build directory {args.build_dir} is ready for NFC-Mode comparison "
"between the two revisions."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep the example commands? I copy-paste from them often

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do, thanks! Setting up the wrapper now stays under a flag, so I'll reintroduce this example when I rebase the patch.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forced pushed to rebase and handle this.
llvm-bolt is available only when the --create-wrapper flag is used (as a wrapper).
In that case, the commands are valid and now printed.

Also applied a few more nits.

@paschalis-mpeis paschalis-mpeis force-pushed the users/paschalis-mpeis/nfc-check-improve-file-handling branch from 6648b77 to 09363a8 Compare July 3, 2025 09:55
@paschalis-mpeis paschalis-mpeis force-pushed the users/paschalis-mpeis/nfc-check-update-guidance branch from 8cc8661 to 4284499 Compare July 4, 2025 14:13
Copy link

github-actions bot commented Jul 4, 2025

✅ With the latest revision this PR passed the Python code formatter.

@paschalis-mpeis paschalis-mpeis force-pushed the users/paschalis-mpeis/nfc-check-update-guidance branch from 4284499 to 2b5e54e Compare July 4, 2025 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants