Index: clang-tools-extra/docs/clang-rename.rst =================================================================== --- clang-tools-extra/docs/clang-rename.rst +++ clang-tools-extra/docs/clang-rename.rst @@ -23,6 +23,12 @@ Using Clang-Rename ================== +:program:`clangd ` uses +:program:`clang-rename` infrastructure to handle renaming requests. Because of +much better editor integration and support, it is advised to use +:program:`clangd-rename` as part of :program:`clangd`. However, it is possible +to use the standalone tool. + :program:`clang-rename` is a `LibTooling `_-based tool, and it's easier to work with if you set up a compile command database for your project (for an @@ -140,7 +146,7 @@ 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 -`_. +`_. Please note that **you have to save all buffers, in which the replacement will happen before running the tool**. @@ -157,7 +163,7 @@ You can also use :program:`clang-rename` while using Emacs! To set up :program:`clang-rename` integration for Emacs see `clang-rename/tool/clang-rename.el -`_. +`_. Once installed, you can point your cursor to symbols you want to rename, press `M-X`, type `clang-rename` and new desired name.