[llvm] [llvm][docs] 2 small fixes to GitHub guide (PR #134620)
David Spickett via llvm-commits
llvm-commits at lists.llvm.org
Mon Apr 7 08:38:13 PDT 2025
https://github.com/DavidSpickett updated https://github.com/llvm/llvm-project/pull/134620
>From adc7edacb71b719f01d1528526a3aa878e01cb49 Mon Sep 17 00:00:00 2001
From: David Spickett <david.spickett at linaro.org>
Date: Mon, 7 Apr 2025 12:37:09 +0000
Subject: [PATCH 1/2] [llvm][docs] 2 small fixes to GitHub guide
1. `arc` is long gone, no need to mention it.
2. Say exactly where user branches can be made.
---
llvm/docs/GitHub.rst | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index 7b614b6ca5d45..7a3dccacd7247 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -42,8 +42,7 @@ GitHub Tools
You can interact with GitHub in several ways: via git command line tools,
the web browser, `GitHub Desktop <https://desktop.github.com/>`_, or the
`GitHub CLI <https://cli.github.com>`_. This guide will cover the git command line
-tools and the GitHub CLI. The GitHub CLI (`gh`) will be most like the `arc` workflow and
-recommended.
+tools and the GitHub CLI.
Creating Pull Requests
----------------------
@@ -219,7 +218,7 @@ commonly used first:
Branches
========
-It is possible to create branches that start with `users/<username>/`, however this is
+It is possible to create branches in `llvm/llvm-project/` that start 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 above). User branches that
aren't associated with a pull-request **will be deleted**.
>From 4e381759d3577b67113f8336e5c53d677a4ad199 Mon Sep 17 00:00:00 2001
From: David Spickett <david.spickett at linaro.org>
Date: Mon, 7 Apr 2025 15:37:58 +0000
Subject: [PATCH 2/2] wrap text
---
llvm/docs/GitHub.rst | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index 7a3dccacd7247..c33027daf6447 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -218,10 +218,11 @@ commonly used first:
Branches
========
-It is possible to create branches in `llvm/llvm-project/` that start 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 above). User branches that
-aren't associated with a pull-request **will be deleted**.
+It is possible to create branches in `llvm/llvm-project/` that start 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 above). User branches that aren't
+associated with a pull-request **will be deleted**.
Stacked Pull Requests
=====================
More information about the llvm-commits
mailing list