Skip to content

[docs] GettingStarted.md: Do not suggest to run tests when building toolchain #61633

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 1 commit into from
Oct 19, 2022

Conversation

AnthonyLatsis
Copy link
Collaborator

  • Running the entire test suite is unnecessarily burdensome for newcomers, given the already considerable build times.
  • Test failures are not a beginner-friendly indication of an out-of-sync checkout, nor is such an indication generally worth the expenses.
  • We do not want a known issue to block anyone’s workflow.

@AnthonyLatsis
Copy link
Collaborator Author

AnthonyLatsis commented Oct 19, 2022

Just noticed that GitHub created a branch in Apple’s repo rather than my fork. Starting to feel like I’ll never do stuff like this in the browser again.

…oolchain

* Running the entire test suite is unnecessarily burdensome for newcomers, given
  the already considerable build times.
* Test failures are not a beginner-friendly indication of an out-of-sync
  checkout, nor is such an indication generally worth the expenses.
* We do not want a known issue to block anyone’s workflow.
Comment on lines +508 to -525
In the rare event that a local test failure happens to be unrelated to your
changes (is not due to stale binaries and reproduces without your changes),
there is a good chance that it has already been caught by our continuous
integration infrastructure, and it may be ignored.

If you want to rerun all the tests, you can either rebuild the whole project
and use `lit.py` without `--filter` or use `run-test` to handle both aspects.

Recall the baseline failures mentioned in
[the build section](#the-actual-build). If your baseline had failing tests, make
sure you compare the failures seen after your changes to the baseline. If some
test failures look totally unrelated to your changes, there is a good chance
that they were already failing as part of the baseline.

Copy link
Collaborator Author

@AnthonyLatsis AnthonyLatsis Oct 19, 2022

Choose a reason for hiding this comment

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

Spotted this now-dead reference and reworded the paragraph.

@AnthonyLatsis
Copy link
Collaborator Author

@swift-ci please smoke test

@AnthonyLatsis AnthonyLatsis merged commit 15afeeb into main Oct 19, 2022
@AnthonyLatsis AnthonyLatsis deleted the AnthonyLatsis-patch-1 branch October 19, 2022 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants