From abf16a584fbba23be0b61b7e8789d8fa405b2744 Mon Sep 17 00:00:00 2001 From: Jordan Rupprecht Date: Mon, 10 Jun 2019 17:00:49 +0000 Subject: [PATCH] [docs] Add 'git llvm revert' to getting started guide Summary: This documents `git llvm revert rNNNNNN` in the getting started guide for broader visibility. Reviewers: jyknight, mehdi_amini Subscribers: llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D63023 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@362966 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/GettingStarted.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/GettingStarted.rst b/docs/GettingStarted.rst index 5901d28aa28..524a3c250b3 100644 --- a/docs/GettingStarted.rst +++ b/docs/GettingStarted.rst @@ -525,6 +525,26 @@ through all the steps of committing _without_ actually doing the commit, and tell you what it would have done. That can be useful if you're unsure whether the right thing will happen. +Reverting a change when using Git +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you're using Git and need to revert a patch, Git needs to be supplied a +commit hash, not an svn revision. To make things easier, you can use +``git llvm revert`` to revert with either an SVN revision or a Git hash instead. + +Additionally, you can first run with ``git llvm revert -n`` to print which Git +commands will run, without doing anything. + +Running ``git llvm revert`` will only revert things in your local repository. To +push the revert upstream, you still need to run ``git llvm push`` as described +earlier. + +.. code-block:: console + + % git llvm revert rNNNNNN # Revert by SVN id + % git llvm revert abcdef123456 # Revert by Git commit hash + % git llvm revert -n rNNNNNN # Print the commands without doing anything + Checkout via SVN (deprecated) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- 2.11.0