Skip to content

Update GitHub doc to mention that we accepts user branches for Stacked PRs #73774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 5, 2023
+10 −4
Merged

Update GitHub doc to mention that we accepts user branches for Stacked PRs #73774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions llvm/docs/GettingStarted.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
9 changes: 5 additions & 4 deletions llvm/docs/GitHub.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
=============
Expand Down