Index: clang-rename/tool/clang-rename.py =================================================================== --- clang-rename/tool/clang-rename.py +++ clang-rename/tool/clang-rename.py @@ -9,13 +9,13 @@ To install, simply put this into your ~/.vimrc - map ,cr :pyf /clang-rename.py + noremap cr :pyf /clang-rename.py 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 'cr'. You will be prompted for a new +name if the cursor points to a valid symbol. ''' import vim Index: docs/clang-rename.rst =================================================================== --- docs/clang-rename.rst +++ docs/clang-rename.rst @@ -92,8 +92,11 @@ `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 the symbols you want to rename, +press ``cr`` and print new desired name. The +[`` 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. Index: docs/include-fixer.rst =================================================================== --- docs/include-fixer.rst +++ docs/include-fixer.rst @@ -60,10 +60,14 @@ .. code-block:: console - map ,cf :pyf path/to/llvm/source/tools/clang/tools/extra/include-fixer/tool/clang-include-fixer.py - -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. + noremap cf :pyf path/to/llvm/source/tools/clang/tools/extra/include-fixer/tool/clang-include-fixer.py + +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. The +[`` 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`: Index: include-fixer/tool/clang-include-fixer.py =================================================================== --- include-fixer/tool/clang-include-fixer.py +++ include-fixer/tool/clang-include-fixer.py @@ -2,10 +2,10 @@ # - 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 +# noremap cf :pyf path/to/llvm/source/tools/clang/tools/extra/include-fixer/tool/clang-include-fixer.py # -# 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 "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 #