[llvm] 0bfaed8 - [Docs][Github] Say '--delete-branch' instead of '--delete' and '--delete branch'

Bjorn Pettersson via llvm-commits llvm-commits at lists.llvm.org
Mon Sep 25 02:26:45 PDT 2023


Author: Bjorn Pettersson
Date: 2023-09-25T11:26:31+02:00
New Revision: 0bfaed8c612705cfa8c5382d26d8089a0a26386b

URL: https://github.com/llvm/llvm-project/commit/0bfaed8c612705cfa8c5382d26d8089a0a26386b
DIFF: https://github.com/llvm/llvm-project/commit/0bfaed8c612705cfa8c5382d26d8089a0a26386b.diff

LOG: [Docs][Github] Say '--delete-branch' instead of '--delete' and '--delete branch'

The documentation for how to use "gh pr merge" was broken.
In one place it said '--delete-branch' (which seem to be correct for
that option). But in second place it said '--delete branch' and in a
third place it just said '--delete'.
Make sure '--delete-branch' is used in all three places.

Added: 
    

Modified: 
    llvm/docs/GitHub.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index 12fa127efad5df0..79f1479716faefa 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -156,7 +156,7 @@ merge:
 ::
 
   git push -f
-  gh pr merge --squash --delete branch
+  gh pr merge --squash --delete-branch
 
 This force push may ask if you intend to push hundreds, or potentially
 thousands of patches (depending on how long it's been since your pull request
@@ -248,7 +248,7 @@ checks:
   git push origin my_change -f
 
   # Now merge it
-  gh pr merge --squash --delete
+  gh pr merge --squash --delete-branch
 
 
 See more in-depth information about how to contribute in the following documentation:


        


More information about the llvm-commits mailing list