Skip to content

Commit a8e388b

Browse files
committed
Update GitHub doc to mention that we accepts user branches for Stacked PR.
This isn't yet a guide on how to do stacked PRs.
1 parent d6e8f3b commit a8e388b

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

llvm/docs/GettingStarted.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ Getting the Source Code and Building LLVM
4040

4141
``git clone --depth 1 https://github.com/llvm/llvm-project.git``
4242

43+
* You are likely only interested in the main branch moving forward, if
44+
you don't want `git fetch` (or `git pull`) to download user branches, use:
45+
46+
``sed 's#fetch = +refs/heads/\*:refs/remotes/origin/\*#fetch = +refs/heads/main:refs/remotes/origin/main# -i llvm-project/.git/config``
47+
4348
#. Configure and build LLVM and Clang:
4449

4550
* ``cd llvm-project``

llvm/docs/GitHub.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ participate in the project using GitHub.
1717

1818
Branches
1919
========
20-
Do not create any branches in the llvm/llvm-project repository. This repository
21-
is reserved for official project branches only. We may relax this rule in
22-
the future if needed to support "stacked" pull request, but in that case only
23-
branches being used for "stacked" pull requests will be allowed.
20+
21+
It is possible to create branches that starts with `users/<username>/`, however this is
22+
intended to be able to support "stacked" pull-request. Do not create any branches in the
23+
llvm/llvm-project repository otherwise, please use a fork (see below). User branches that
24+
aren't associated with a pull-request **will be deleted**.
2425

2526
Pull Requests
2627
=============

0 commit comments

Comments
 (0)