[llvm] 725a040 - Update GitHub doc to mention that we accepts user branches for Stacked PRs (#73774)

[via llvm-commits]

Author: Mehdi Amini
Date: 2023-12-04T18:26:44-08:00
New Revision: 725a04066a210fdd812a56c3a6256cc97c0aaf4d

URL: https://github.com/llvm/llvm-project/commit/725a04066a210fdd812a56c3a6256cc97c0aaf4d
DIFF: https://github.com/llvm/llvm-project/commit/725a04066a210fdd812a56c3a6256cc97c0aaf4d.diff

LOG: Update GitHub doc to mention that we accepts user branches for Stacked PRs (#73774)

This isn't yet a guide on how to do stacked PRs.

Added: 
    

Modified: 
    llvm/docs/GettingStarted.rst
    llvm/docs/GitHub.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst
index 048d521670f5c..24ed7118ee814 100644
--- a/llvm/docs/GettingStarted.rst
+++ b/llvm/docs/GettingStarted.rst
@@ -40,6 +40,11 @@ Getting the Source Code and Building LLVM
 
      ``git clone --depth 1 https://github.com/llvm/llvm-project.git``
 
+   * You are likely only interested in the main branch moving forward, if
+     you don't want `git fetch` (or `git pull`) to download user branches, use:
+
+     ``sed 's#fetch = +refs/heads/\*:refs/remotes/origin/\*#fetch = +refs/heads/main:refs/remotes/origin/main# -i llvm-project/.git/config``
+
 #. Configure and build LLVM and Clang:
 
    * ``cd llvm-project``

diff  --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index 67fea9520aab6..a89a4d955fc08 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -17,10 +17,11 @@ participate in the project using GitHub.
 
 Branches
 ========
-Do not create any branches in the llvm/llvm-project repository.  This repository
-is reserved for official project branches only.  We may relax this rule in
-the future if needed to support "stacked" pull request, but in that case only
-branches being used for "stacked" pull requests will be allowed.
+
+It is possible to create branches that starts with `users/<username>/`, however this is
+intended to be able to support "stacked" pull-request. Do not create any branches in the
+llvm/llvm-project repository otherwise, please use a fork (see below). User branches that
+aren't associated with a pull-request **will be deleted**.
 
 Pull Requests
 =============