[PATCH] D51292: [clang-rename] Update documentation
Kirill Bobyrev via Phabricator via cfe-commits
cfe-commits at lists.llvm.org
Mon Aug 27 02:45:55 PDT 2018
kbobyrev updated this revision to Diff 162643.
kbobyrev added a comment.
Add missing `_` after the link.
https://reviews.llvm.org/D51292
Files:
clang-tools-extra/docs/clang-rename.rst
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
`clang-rename/tool/clang-rename.py
-<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-rename/tool/clang-rename.py>`_.
+<https://reviews.llvm.org/diffusion/L/browse/cfe/trunk/tools/clang-rename/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
-<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-rename/tool/clang-rename.el>`_.
+<https://reviews.llvm.org/diffusion/L/browse/cfe/trunk/tools/clang-rename/clang-rename.py>`_.
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.162643.patch
Type: text/x-patch
Size: 1790 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20180827/79ecb6b4/attachment.bin>
More information about the cfe-commits
mailing list