Skip to content

Update benchmark readme with info on how to ensure benchmarks test locally built stdlib #79528

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

Merged
merged 6 commits into from
Feb 25, 2025

Conversation

iThinker
Copy link
Contributor

I recently tried to run modify stdlib and run benchmarks, but I had issues with it, and readme was not helpful enough.
This PR adds a bit of info to readme to help future readers.

Problems addressed:

  1. Building standalone benchmarks fails when using standard xcode toolchains. In my case error looked like - error: cannot find '_wordIndex' in scope.
  2. I could not make benchmarks use locally built stdlib. Even though this readme says they should use ../lib/swift. So the two env variables helped me solve the problem.

Special thanks to @Catfish-Man for helping with these.

@iThinker iThinker requested a review from eeckstein as a code owner February 20, 2025 21:26
@eeckstein
Copy link
Contributor

eeckstein commented Feb 21, 2025

The easiest way to run the benchmarks - actually: compare two benchmark builds - is to use the scripts/run_smoke_bench script. This is unfortunately also not documented.
This script e.g. takes care of setting DYLD_LIBRARY_PATH

@iThinker
Copy link
Contributor Author

@eeckstein can you please help me trigger necessary CI checks so that this PR becomes mergeable?

Copy link
Collaborator

@AnthonyLatsis AnthonyLatsis left a comment

Choose a reason for hiding this comment

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

Thank you. Could you reformat these additions to stick to the 80 chars per line limit?

@AnthonyLatsis
Copy link
Collaborator

@swift-ci please smoke test

@AnthonyLatsis AnthonyLatsis enabled auto-merge (squash) February 24, 2025 22:20
@AnthonyLatsis AnthonyLatsis self-assigned this Feb 24, 2025
@AnthonyLatsis AnthonyLatsis merged commit 2775182 into swiftlang:main Feb 25, 2025
3 checks passed
@AnthonyLatsis AnthonyLatsis removed their assignment Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants