revi-archive/llvm-premerge-checks
1
0
Fork 0
Code Activity

Fixed some doc typos. (#116)

Browse source
This commit is contained in:
Jan Kratochvil 2020-02-03 09:41:15 +01:00 committed by GitHub
parent c7d2686251
commit bc971e0016
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -13,19 +13,19 @@ Maria is a developer working on a new idea for the LLVM project. When she submit
* run check-all
* run clang-format and clang-tidy
Once a check is completed, the results are are attached to the Diff in Phabricator so that Maria is notified automatically with the results. Now she can check if the pre-merge checks passed and fix things as required. This way she does not have to run all checks on her local machine by hand. The first results are available within 2 hours of a change, but typically within 30 minutes.
Once a check is completed, the results are attached to the Diff in Phabricator so that Maria is notified automatically with the results. Now she can check if the pre-merge checks passed and fix things as required. This way she does not have to run all checks on her local machine by hand. The first results are available within 2 hours of a change, but typically within 30 minutes.
As the pre-merge check cover the easy parts, a human reviewer can focus on the parts that the machine cannot cover. The pre-merge checks are optional, so a reviewer can also decide to ignore them if they do not work, take too long, or do not make sense.
The build bots are still in place as they cover a much wider range of checks on the different platforms. So after Maria’s change has landed, the build bots might still find more bugs that were not found in the pre-merge checks. The number should be lower than what we have today though.
# Roadmap
During the LLVM developer meeting in Octover 2019, this was the roadmap we discussed:
During the LLVM developer meeting in October 2019, this was the roadmap we discussed:
* Until mid of November: preparation of the infrastructure for the beta testing
* Mid of November:
* Announcement of the public beta testing phase on the LLVM mailing list.
* Interested users are white-listed on the Herald rule.
* Until Januar: Beta testing for interested users.
* Until January: Beta testing for interested users.
* In January:
* Based on the feedback so far: enable pre-merge tests for all users.
* Users can opt-out via a black-list in the Herald rule.

2
docs/user_doc.md
View file

@ -23,7 +23,7 @@ If you find any problems please raise an [issue on github](https://github.com/go
## Sign up for beta test
To sign up for the pre-merge beta testing, please add yourself to the ["pre-merge beta testing" project](https://reviews.llvm.org/project/members/78/) on Phabricator ([H511](https://reviews.llvm.org/H11)).
To sign up for the pre-merge beta testing, please add yourself to the ["pre-merge beta testing" project](https://reviews.llvm.org/project/members/78/) on Phabricator ([H511](https://reviews.llvm.org/H511)).
The checks are enabled for all changes to `clang-tools-extra/clangd` ([H527](https://reviews.llvm.org/H527)) and `mlir`([H552](https://reviews.llvm.org/H552)).