[PATCH] D80088: [llvm][docs] Add step by step git to GettingStarted

[Zola Bridges via Phabricator via llvm-commits]

zbrid updated this revision to Diff 264654.
zbrid marked an inline comment as done.
zbrid added a comment.

Change the dry-run command to mehdi's suggestion


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D80088/new/

https://reviews.llvm.org/D80088

Files:
  llvm/docs/GettingStarted.rst


Index: llvm/docs/GettingStarted.rst
===================================================================
--- llvm/docs/GettingStarted.rst
+++ llvm/docs/GettingStarted.rst
@@ -496,10 +496,28 @@
 `obtaining commit access <DeveloperPolicy.html#obtaining-commit-access>`_
 for commit access.
 
+Here is an example workflow using git. This workflow assumes you have an
+accepted commit on the branch named `branch-with-change`.
+
+.. code-block:: console
+
+  # Go to the branch with your accepted commit.
+  % git checkout branch-with-change
+  # Rebase your change onto the latest commits on Github.
+  % git pull --rebase origin master
+  # Rerun the appropriate tests if needed.
+  % ninja check-$whatever
+  # Check that the list of commits about to be pushed is correct.
+  % git log origin/master...HEAD --oneline
+  # Push to Github.
+  % git push origin HEAD:master
+
 LLVM currently has a linear-history policy, which means that merge commits are
 not allowed. The `llvm-project` repo on github is configured to reject pushes
 that include merges, so the `git rebase` step above is required.
 
+Please ask for help if you're having trouble with your particular git workflow.
+
 Bisecting commits
 ^^^^^^^^^^^^^^^^^
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D80088.264654.patch
Type: text/x-patch
Size: 1221 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200518/25465ea5/attachment.bin>