[llvm] [docs] Stress out the branch naming scheme for Graphite. (PR #104499)
Mircea Trofin via llvm-commits
llvm-commits at lists.llvm.org
Thu Aug 15 14:12:54 PDT 2024
https://github.com/mtrofin updated https://github.com/llvm/llvm-project/pull/104499
>From a54b27d9d77cd7ff3507faf5a3691d9430520f5a Mon Sep 17 00:00:00 2001
From: Mircea Trofin <mtrofin at google.com>
Date: Thu, 15 Aug 2024 13:22:04 -0700
Subject: [PATCH] [docs] Stress out the branch naming scheme for Graphite.
---
llvm/docs/GitHub.rst | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index 14424f722abf63..f8447e0c3c2333 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -23,6 +23,23 @@ intended to be able to support "stacked" pull-request. Do not create any branche
llvm/llvm-project repository otherwise, please use a fork (see below). User branches that
aren't associated with a pull-request **will be deleted**.
+Using Graphite for stacked Pull Requests
+========================================
+
+[Graphite](https://app.graphite.dev/) is a stacked pull request tool supported
+by the LLVM repo (the other being [reviewable.io](https://reviewable.io)).
+
+Graphite will want to create branches under `llvm/llvm-project` rather than your
+private fork, so the guidance above is critical, otherwise it will fail to
+`gt submit` (i.e. publish your PRs for review)
+
+Use `gt config` then `Branch naming settings` and `Set a prefix for branch names`.
+Include the last `/`.
+
+If you didn't do the above and Graphite created non-prefixed branches, a simple way to
+unblock is to rename (`git -m <old name> <new name>`), and then checkout the branch
+and `gt track`.
+
Pull Requests
=============
The LLVM project is using GitHub Pull Requests for Code Reviews. This document
More information about the llvm-commits
mailing list