summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRubén Dávila <rdavila84@gmail.com>2016-02-17 12:04:24 -0500
committerRobert Speicher <rspeicher@gmail.com>2016-02-19 13:15:42 -0500
commitd6e3abccb82ac112979cb1cea0b34faddbced358 (patch)
treeb4c0b36e536058ee2ead8051b6b895560575ad7c
parent112b1add4c4f9347d4bc0f6b20a8fd37384a81f2 (diff)
downloadgitlab-ce-d6e3abccb82ac112979cb1cea0b34faddbced358.tar.gz
Add documentation for revert changes feature.
-rw-r--r--doc/workflow/revert_changes.md36
-rw-r--r--doc/workflow/revert_changes/revert-commit-modal.pngbin0 -> 327932 bytes
-rw-r--r--doc/workflow/revert_changes/revert-commit.pngbin0 -> 360098 bytes
-rw-r--r--doc/workflow/revert_changes/revert-mr-modal.pngbin0 -> 335010 bytes
-rw-r--r--doc/workflow/revert_changes/revert-mr.pngbin0 -> 367881 bytes
5 files changed, 36 insertions, 0 deletions
diff --git a/doc/workflow/revert_changes.md b/doc/workflow/revert_changes.md
new file mode 100644
index 00000000000..079b92f8b10
--- /dev/null
+++ b/doc/workflow/revert_changes.md
@@ -0,0 +1,36 @@
+# Reverting changes
+
+The new `Revert` button allows you to revert any changes introduced by a Commit or a Merge Request.
+
+## Reverting a Merge Request
+
+After the Merge Request has been merged, a `Revert` button will be available to revert the changes introduced by that Merge Request:
+
+![revert merge request](revert_changes/revert-mr.png)
+
+You can revert the changes directly into the selected branch or you can opt to create a new Merge Request with the revert changes:
+
+![revert merge request modal](revert_changes/revert-mr-modal.png)
+
+After the Merge Request has been reverted, the `Revert` button will not be available anymore.
+
+It's important to mention that this new button will be only available for Merge Requests created since the **8.5** version. However you can still revert a Merge by reverting the merge commit from the list of Commits page.
+
+## Reverting a Commit
+
+You can revert a Commit from the Commit detail page:
+
+![revert commit](revert_changes/revert-commit.png)
+
+In the same way like reverting a Merge Request you can opt to revert the changes directly into the target branch or create a new Merge Request to revert the changes:
+
+![revert commit modal](revert_changes/revert-commit-modal.png)
+
+After the Commit has been reverted, the `Revert` button will not be available anymore.
+
+Please note that when reverting merge commits, the mainline will allways be the first parent, if you want to use a different mainline then you need to do that from the command line, here is a quick sample:
+
+```
+# Revert a merge commit using the second parent as the mainline
+git revert -m 2 commit_hash
+```
diff --git a/doc/workflow/revert_changes/revert-commit-modal.png b/doc/workflow/revert_changes/revert-commit-modal.png
new file mode 100644
index 00000000000..e94d151a2af
--- /dev/null
+++ b/doc/workflow/revert_changes/revert-commit-modal.png
Binary files differ
diff --git a/doc/workflow/revert_changes/revert-commit.png b/doc/workflow/revert_changes/revert-commit.png
new file mode 100644
index 00000000000..d84211e20db
--- /dev/null
+++ b/doc/workflow/revert_changes/revert-commit.png
Binary files differ
diff --git a/doc/workflow/revert_changes/revert-mr-modal.png b/doc/workflow/revert_changes/revert-mr-modal.png
new file mode 100644
index 00000000000..9da78f84828
--- /dev/null
+++ b/doc/workflow/revert_changes/revert-mr-modal.png
Binary files differ
diff --git a/doc/workflow/revert_changes/revert-mr.png b/doc/workflow/revert_changes/revert-mr.png
new file mode 100644
index 00000000000..7adad88463b
--- /dev/null
+++ b/doc/workflow/revert_changes/revert-mr.png
Binary files differ