From ca7bc237ef24ab25d97e2fc5ba2af369cd1cfe7b Mon Sep 17 00:00:00 2001
From: syl20bnr <sylvain.benner@gmail.com>
Date: Mon, 15 Dec 2014 22:48:27 -0500
Subject: [PATCH] Reverts #280 Fix evil-surround vim-surround inconsistency

---
 doc/DOCUMENTATION.md  | 35 +++++++++++++++++++++++++++++++++++
 spacemacs/packages.el |  5 +----
 2 files changed, 36 insertions(+), 4 deletions(-)

diff --git a/doc/DOCUMENTATION.md b/doc/DOCUMENTATION.md
index f6fa00a7b..2a4ba0053 100644
--- a/doc/DOCUMENTATION.md
+++ b/doc/DOCUMENTATION.md
@@ -40,6 +40,8 @@
         - [Base States](#base-states)
     - [Evil leader](#evil-leader)
     - [Universal argument](#universal-argument)
+- [Differences between Vim, Evil and Spacemacs](#differences-between-vim-evil-and-spacemacs)
+    - [The vim-surround case](#the-vim-surround-case)
     - [Micro-states](#micro-states)
 - [Color theme](#color-theme)
 - [UI elements](#ui-elements)
@@ -576,6 +578,39 @@ a very handy Vim key binding to scroll up.
 `Spacemacs` binds <kbd>C-u</kbd> to `scroll-up` and change the universal
 argument binding to <kbd>SPC u</kbd>.
 
+# Differences between Vim, Evil and Spacemacs
+
+No doubt that `Evil` is one of the most advanced `Vim` emulation and you should
+not see big difference between `Vim` and `Emacs`. I did not find any command I
+used in Vim that I missed in Emacs with `Evil`
+
+Send a PR to add the differences you found in this section.
+
+## The vim-surround case
+
+There is one more visible difference though. It is not between `Evil` and `Vim`
+but between `Spacemacs` and [vim-surround][]: the `surround` command is on
+<kbd>S</kbd> in `vim-surround` whereas it is on <kbd>s</kbd> in `Spacemacs`.
+
+This is something that can surprise some Vim users so let me explain why this is
+the case:
+- `s` and `c` do the same thing in `visual state`,
+- `s` is only useful to delete _one_ character and add more than one character
+which is a _very_ narrow use case,
+- `c` accept motions and can do everything `s` can do in `normal state`,
+- this is also true for `r` but `r` is more useful because it stays in
+`normal state`.
+- `surround` command is just a more powerful command that `s`
+
+If you are not convinced, then here is the snippet to revert back to the default
+`Vim + vim-surround` setup (add it to your `dotspacemacs/config` function or
+your `~/.spacemacs`):
+
+```elisp
+(evil-define-key 'visual evil-surround-mode-map "s" 'evil-substitute)
+(evil-define-key 'visual evil-surround-mode-map "S" 'evil-surround-region)
+```
+
 ## Micro-states
 
 `Spacemacs` defines a wide variety of `micro-states` (temporary overlay maps)
diff --git a/spacemacs/packages.el b/spacemacs/packages.el
index 6946b92b3..e5a40ec89 100644
--- a/spacemacs/packages.el
+++ b/spacemacs/packages.el
@@ -705,10 +705,7 @@ determine the state to enable when escaping from the insert state.")
 
 (defun spacemacs/init-evil-surround ()
   (use-package evil-surround
-    :init (progn
-            (global-evil-surround-mode 1)
-            (evil-define-key 'visual evil-surround-mode-map "s" 'evil-substitute)
-            (evil-define-key 'visual evil-surround-mode-map "S" 'evil-surround-region))))
+    :init (global-evil-surround-mode 1)))
 
 (defun spacemacs/init-evil-terminal-cursor-changer ()
   (unless (display-graphic-p)