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

Kirill Bobyrev via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Mon Aug 27 02:44:34 PDT 2018

kbobyrev created this revision.
kbobyrev added reviewers: ioeric, ilya-biryukov.
Herald added a subscriber: kadircet.

Clangd has way better editor support compared to the ad-hoc integration I created before and we should point users to Clangd mentioning that they could still use standalone tool if they really want to.

Also, links to the Vim and Emacs scripts were not updated after the move from clang-tools-extra to clang.



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 <https://clang.llvm.org/extra/clangd.html>` 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
 <http://clang.llvm.org/docs/LibTooling.html>`_-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
 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
 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.162641.patch
Type: text/x-patch
Size: 1789 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20180827/f1667f3c/attachment.bin>

More information about the cfe-commits mailing list