Skip to content

Commit b13e9ef

Browse files
authored
Update llvm/docs/MyFirstTypoFix.rst for post-Phabricator / Pull-requests world (#70310)
1 parent b1bb239 commit b13e9ef

File tree

1 file changed

+15
-84
lines changed

1 file changed

+15
-84
lines changed

llvm/docs/MyFirstTypoFix.rst

+15-84
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,6 @@ We're going to need some tools:
6666

6767
- python: to run the LLVM tests,
6868

69-
- arcanist: for uploading changes for review,
70-
7169
As an example, on Ubuntu:
7270

7371
.. code:: console
@@ -345,42 +343,21 @@ all the \*-commits mailing lists).
345343
Uploading a change for review
346344
-----------------------------
347345

348-
.. warning::
349-
350-
Phabricator is deprecated and will be switched to read-only mode in October
351-
2023. For new code contributions use :ref:`GitHub Pull Requests <github-reviews>`.
352-
This section contains old information that needs to be updated.
353-
354-
LLVM code reviews happen at https://reviews.llvm.org. The web interface
355-
is called Phabricator, and the code review part is Differential. You
356-
should create a user account there for reviews (click "Log In" and then
357-
"Register new account").
358-
359-
Now you can upload your change for review:
360-
361-
.. code:: console
362-
363-
$ arc diff HEAD^
364-
365-
This creates a review for your change, comparing your current commit
366-
with the previous commit. You will be prompted to fill in the review
367-
details. Your commit message is already there, so just add cfe-commits
368-
under the "subscribers" section. It should print a code review URL:
369-
https://reviews.llvm.org/D58291 You can always find your active reviews
370-
on Phabricator under "My activity".
371-
346+
LLVM code reviews happen through pull-request on GitHub, see
347+
:ref:`GitHub <github-reviews>` documentation for how to open
348+
a pull-request on GitHub.
372349

373350
Review process
374351
--------------
375352

376-
When you upload a change for review, an email is sent to you, the
377-
cfe-commits list, and anyone else subscribed to these kinds of changes.
353+
When you open a pull-request, some automation will add a comment and
354+
notify different member of the projects depending on the component you
355+
changed.
378356
Within a few days, someone should start the review. They may add
379357
themselves as a reviewer, or simply start leaving comments. You'll get
380358
another email any time the review is updated. The details are in the
381359
`https://llvm.org/docs/CodeReview/ <https://llvm.org/docs/CodeReview.html>`__.
382360

383-
384361
Comments
385362
~~~~~~~~
386363

@@ -395,37 +372,30 @@ page.
395372
Updating your change
396373
~~~~~~~~~~~~~~~~~~~~
397374

398-
If you make changes in response to a reviewer's comments, simply run
399-
400-
.. code:: console
401-
402-
$ arc diff
403-
404-
again to update the change and notify the reviewer. Typically this is a
405-
good time to send any draft comments as well.
406-
375+
If you make changes in response to a reviewer's comments, simply update
376+
your branch with more commits and push to your fork. It may be a good
377+
idea to answer the comments from the reviewer explicitly.
407378

408379
Accepting a revision
409380
~~~~~~~~~~~~~~~~~~~~
410381

411382
When the reviewer is happy with the change, they will **Accept** the
412383
revision. They may leave some more minor comments that you should
413384
address, but at this point the review is complete. It's time to get it
414-
committed!
385+
merged!
415386

416387

417388
Commit by proxy
418389
---------------
419390

420-
As this is your first change, you won't have access to commit it
391+
As this is your first change, you won't have access to merge it
421392
yourself yet. The reviewer **doesn't know this**, so you need to tell
422393
them! Leave a message on the review like:
423394

424395
Thanks @somellvmdev. I don't have commit access, can you land this
425-
patch for me? Please use "My Name my@email" to commit the change.
426-
427-
The review will be updated when the change is committed.
396+
patch for me?
428397

398+
The pull-request will be closed and you will be notified by GitHub.
429399

430400
Review expectations
431401
-------------------
@@ -484,46 +454,6 @@ changes (e.g. [email protected]), as discussion often happens
484454
there if a new patch causes problems.
485455

486456

487-
Commit
488-
------
489-
490-
Let's say you have a change on a local git branch, reviewed and ready to
491-
commit. Things to do first:
492-
493-
- if you used multiple fine-grained commits locally, squash them into a
494-
single commit. LLVM prefers commits to match the code that was
495-
reviewed. (If you created one commit and then used "arc diff", you're
496-
fine)
497-
498-
- rebase your patch against the latest LLVM code. LLVM uses a linear
499-
history, so everything should be based on an up-to-date origin/main.
500-
501-
.. code:: console
502-
503-
$ git pull --rebase https://github.com/llvm/llvm-project.git main
504-
505-
- ensure the patch looks correct.
506-
507-
.. code:: console
508-
509-
$ git show
510-
511-
- run the tests one last time, for good luck
512-
513-
At this point git show should show a single commit on top of
514-
origin/main.
515-
516-
Now you can push your commit with
517-
518-
.. code:: console
519-
520-
$ git push https://github.com/llvm/llvm-project.git HEAD:main
521-
522-
You should see your change `on
523-
GitHub <https://github.com/llvm/llvm-project/commits/main>`__ within
524-
minutes.
525-
526-
527457
Post-commit errors
528458
------------------
529459

@@ -559,7 +489,8 @@ buildbots, overview of bots, getting error logs.
559489
Reverts
560490
-------
561491

562-
if in doubt, revert and re-land.
492+
If in doubt, revert immediately, and re-land later after investigation
493+
and fix.
563494

564495

565496
Conclusion

0 commit comments

Comments
 (0)