[PATCH] D51292: [docs] Update clang-rename documentation

Kirill Bobyrev via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Wed Aug 29 01:23:16 PDT 2018

kbobyrev updated this revision to Diff 163025.
kbobyrev marked 3 inline comments as done.
kbobyrev added a comment.

Moved the note about Clangd integration to the end, rephrased a bit.



Index: clang-tools-extra/docs/clang-rename.rst
--- clang-tools-extra/docs/clang-rename.rst
+++ clang-tools-extra/docs/clang-rename.rst
@@ -134,13 +134,23 @@
     -pn                        - Print the found symbol's name prior to renaming to stderr.
     -qualified-name=<string>   - The fully qualified name of the symbol.
+Clangd Integration
+:program:`clangd <https://clang.llvm.org/extra/clangd.html>`_ uses
+:program:`clang-rename` infrastructure to handle renaming requests. Currently,
+it only supports renaming symbol within a single file, but in the future it will
+have much better support than the standalone tool. Consider switching to
+:program:`clangd` in the future since it is supported in most editors such as
+Vim, Emacs and Visual Studio Code.
 Vim Integration
 You can call :program:`clang-rename` directly from Vim! To set up
 :program:`clang-rename` integration for Vim see
 Please note that **you have to save all buffers, in which the replacement will
 happen before running the tool**.
@@ -157,7 +167,7 @@
 You can also use :program:`clang-rename` while using Emacs! To set up
 :program:`clang-rename` integration for Emacs see
 Once installed, you can point your cursor to symbols you want to rename, press
 `M-X`, type `clang-rename` and new desired name.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D51292.163025.patch
Type: text/x-patch
Size: 1876 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20180829/a3e711ab/attachment.bin>

More information about the cfe-commits mailing list