Skip to content

Commit a54b27d

Browse files
committed
[docs] Stress out the branch naming scheme for Graphite.
1 parent 2adc012 commit a54b27d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

llvm/docs/GitHub.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,23 @@ intended to be able to support "stacked" pull-request. Do not create any branche
2323
llvm/llvm-project repository otherwise, please use a fork (see below). User branches that
2424
aren't associated with a pull-request **will be deleted**.
2525

26+
Using Graphite for stacked Pull Requests
27+
========================================
28+
29+
[Graphite](https://app.graphite.dev/) is a stacked pull request tool supported
30+
by the LLVM repo (the other being [reviewable.io](https://reviewable.io)).
31+
32+
Graphite will want to create branches under `llvm/llvm-project` rather than your
33+
private fork, so the guidance above is critical, otherwise it will fail to
34+
`gt submit` (i.e. publish your PRs for review)
35+
36+
Use `gt config` then `Branch naming settings` and `Set a prefix for branch names`.
37+
Include the last `/`.
38+
39+
If you didn't do the above and Graphite created non-prefixed branches, a simple way to
40+
unblock is to rename (`git -m <old name> <new name>`), and then checkout the branch
41+
and `gt track`.
42+
2643
Pull Requests
2744
=============
2845
The LLVM project is using GitHub Pull Requests for Code Reviews. This document

0 commit comments

Comments
 (0)