Skip to content

Commit ce1cd0d

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

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

llvm/docs/GitHub.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ 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+
Note: this is particularly necessary if using [Graphite](https://app.graphite.dev/).
27+
To make sure Graphite creates branches following the above pattern, use `gt config`
28+
then `Branch naming settings` and `Set a prefix for branch names`. Include the last
29+
`/`. Otherwise Graphite will fail to `gt submit`. If that happens, a simple way to
30+
unblock is to rename (`git -m <old name> <new name>`), and then checkout the branch
31+
and `gt track`.
32+
2633
Pull Requests
2734
=============
2835
The LLVM project is using GitHub Pull Requests for Code Reviews. This document

0 commit comments

Comments
 (0)