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

Kirill Bobyrev via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Thu Aug 30 04:46:11 PDT 2018

kbobyrev updated this revision to Diff 163305.
kbobyrev marked 4 inline comments as done.
kbobyrev added a comment.
Herald added a subscriber: arphaman.

- Fix the `.py` (should be `.el` in the second case) typo
- Move piece about rename request to Clangd docs and advertise it htere
- Use better wording for Clang-Rename docs advertising Clangd



Index: clang-tools-extra/docs/clangd.rst
--- clang-tools-extra/docs/clangd.rst
+++ clang-tools-extra/docs/clangd.rst
@@ -108,6 +108,17 @@
 | Gen. Getters/Setters                | No         |   No     |
+Rename Limitations
+:program:`Clangd` shares the renaming infrastructure with `Clang-Rename
+<https://clang.llvm.org/extra/clang-rename.html>`_ - a standalone refactoring
+tool. Currently, :program:`Clangd` only supports renaming a symbol within a
+single source file (as opposed to :program:`clang-rename` which handles the
+whole translation unit), but in the future it will have much better support
+than the standalone tool.
 Getting Involved
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,20 @@
     -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>`_ shares the
+renaming infrastructure of clang-rename. Consider switching to :program:`clangd`
+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 +164,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.163305.patch
Type: text/x-patch
Size: 2529 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20180830/17a669c3/attachment.bin>

More information about the cfe-commits mailing list