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

[Zola Bridges via Phabricator via llvm-commits]

zbrid created this revision.
zbrid added reviewers: echristo, dblaikie, spatel.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.
zbrid updated this revision to Diff 264504.
zbrid added a comment.

Add running tests to the workflow


Due to deleting the git llvm script, folks were asking for better documentation
about how to use git in order to commit to the Github repo. I added some step
by step git commands to make the usage clearer.

Context link: http://lists.llvm.org/pipermail/llvm-dev/2020-May/141640.html


Repository:
  rG LLVM Github Monorepo

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 intended push will do the right thing.
+  % git push origin HEAD:master --dry-run
+  # 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.264504.patch
Type: text/x-patch
Size: 1212 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200517/41bdb6b5/attachment.bin>