change Vim key binding for include-fixer and clang-rename

[omtcyfz]

Summary

Change Vim key binding for include-fixer (,cf -> <leader>cf) and clang-rename (,cr -> <leader>cr) to use <leader> instead of , like cool Vim people (tm) do.

[ioeric]

Could you briefly explain what <leader> is and how to lookup/set it in the doc, or at least provide reference?

[vmiklos]

:help leader explains it. Or see this link: http://learnvimscriptthehardway.stevelosh.com/chapters/06.html#leader. The later describes 3 arguments for using <leader> instead of , directly.

[omtcyfz]

add refernce to what <leader> is

[omtcyfz]

In D22854#497496, @vmiklos wrote:

:help leader explains it. Or see this link: http://learnvimscriptthehardway.stevelosh.com/chapters/06.html#leader. The later describes 3 arguments for using <leader> instead of , directly.

I think the point was to put that into documentation :)

[omtcyfz]

Any other comments?

[ioeric]

docs/clang-rename.rst

98 ↗

(On Diff #65714)

s/the symbols/symbols/

101 ↗

(On Diff #65714)

s/a reference to //

sounds redundant..

docs/include-fixer.rst

69 ↗

(On Diff #65714)

s/a reference to //

[omtcyfz]

docs/clang-rename.rst

101 ↗

(On Diff #65714)

Why does it?

Key is a key; key can't be assigned to anything. Reference can be changed to any other key.

[ioeric]

lgtm

docs/clang-rename.rst

101 ↗

(On Diff #65739)

Didn't see it was "<leader> key"... thought it was just "<leader>".

nvm, not important :)

[alexfh]

docs/include-fixer.rst

73 ↗

(On Diff #65739)

s/binded/bound/
Same elsewhere.

[omtcyfz]

docs/clang-rename.rst

101 ↗

(On Diff #65739)

Okay, thank you :)

clang-tools-extra/trunk/clang-rename/tool/clang-rename.py

 '''
 Minimal clang-rename integration with Vim.
 
 Before installing make sure one of the following is satisfied:
 
 * clang-rename is in your PATH
 * `g:clang_rename_path` in ~/.vimrc points to valid clang-rename executable
 * `binary` in clang-rename.py points to valid to clang-rename executable
 
 To install, simply put this into your ~/.vimrc
 
-    map ,cr :pyf <path-to>/clang-rename.py<cr>
+    noremap <leader>cr :pyf <path-to>/clang-rename.py<cr>
 
 IMPORTANT NOTE: Before running the tool, make sure you saved the file.
 
 All you have to do now is to place a cursor on a variable/function/class which
-you would like to rename and press ',cr'. You will be prompted for a new name if
-the cursor points to a valid symbol.
+you would like to rename and press '<leader>cr'. You will be prompted for a new
+name if the cursor points to a valid symbol.
 '''
 
 import vim
 import subprocess
 import sys
 
 def main():
     binary = 'clang-rename'

clang-tools-extra/trunk/docs/clang-rename.rst

 clang-rename Vim integration
 ============================
 
 You can call :program:`clang-rename` directly from Vim! To set up
 :program:`clang-rename` integration for Vim see
 `clang-rename/tool/clang-rename.py
 <http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-rename/tool/clang-rename.py>`_.
 
-Once installed, you can point your cursor to the symbols you want to rename,
-press `,cr` and print new desired name.
-
 Please note that **you have to save all buffers, in which the replacement will
 happen before running the tool**.
+
+Once installed, you can point your cursor to symbols you want to rename, press
+``<leader>cr`` and print new desired name. The
+[``<leader> key``](http://vim.wikia.com/wiki/Mapping_keys_in_Vim_-_Tutorial_(Part_3)#Map_leader)
+is a reference to a specific key defined by the mapleader variable and is binded
+to backslash by default.

clang-tools-extra/trunk/docs/include-fixer.rst

 
 Integrate with Vim
 ------------------
 To run `clang-include-fixer` on a potentially unsaved buffer in Vim. Add the
 following key binding to your ``.vimrc``:
 
 .. code-block:: console
 
-  map ,cf :pyf path/to/llvm/source/tools/clang/tools/extra/include-fixer/tool/clang-include-fixer.py<cr>
+  noremap <leader>cf :pyf path/to/llvm/source/tools/clang/tools/extra/include-fixer/tool/clang-include-fixer.py<cr>
 
-This enables `clang-include-fixer` for NORMAL and VISUAL mode. Change ``,cf`` to
-another binding if you need clang-include-fixer on a different key.
+This enables `clang-include-fixer` for NORMAL and VISUAL mode. Change
+``<leader>cf`` to another binding if you need clang-include-fixer on a different
+key. The
+[``<leader> key``](http://vim.wikia.com/wiki/Mapping_keys_in_Vim_-_Tutorial_(Part_3)#Map_leader)
+is a reference to a specific key defined by the mapleader variable and is binded
+to backslash by default.
 
 Make sure vim can find :program:`clang-include-fixer`:
 
 - Add the path to :program:`clang-include-fixer` to the PATH environment variable.
 - Or set ``g:clang_include_fixer_path`` in vimrc: ``let g:clang_include_fixer_path=path/to/clang-include-fixer``
 
 You can customize the number of headers being shown by setting
 ``let g:clang_include_fixer_maximum_suggested_headers=5``

clang-tools-extra/trunk/include-fixer/tool/clang-include-fixer.py

 # This file is a minimal clang-include-fixer vim-integration. To install:
 # - Change 'binary' if clang-include-fixer is not on the path (see below).
 # - Add to your .vimrc:
 #
-#   map ,cf :pyf path/to/llvm/source/tools/clang/tools/extra/include-fixer/tool/clang-include-fixer.py<cr>
+#   noremap <leader>cf :pyf path/to/llvm/source/tools/clang/tools/extra/include-fixer/tool/clang-include-fixer.py<cr>
 #
-# This enables clang-include-fixer for NORMAL and VISUAL mode. Change ",cf" to
-# another binding if you need clang-include-fixer on a different key.
+# This enables clang-include-fixer for NORMAL and VISUAL mode. Change "<leader>cf"
+# to another binding if you need clang-include-fixer on a different key.
 #
 # To set up clang-include-fixer, see http://clang.llvm.org/extra/include-fixer.html
 #
 # With this integration you can press the bound key and clang-include-fixer will
 # be run on the current buffer.
 #
 # It operates on the current, potentially unsaved buffer and does not create
 # or save any files. To revert a fix, just undo.