[docs] Update clang-rename documentation

[kbobyrev]

Summary

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.

This patch does not introduce any functionality changes.

[kbobyrev]

Add missing _ after the link.

[ilya-biryukov]

clang-tools-extra/docs/clang-rename.rst

28

I would not recommend clangd at this point, it only supports single-file renames, while clang-rename can actually do cross-TU renames IIUC.
Not opposed to putting recommendations of using clangd, of course, but let's be explicit about the limitations.

[kbobyrev]

clang-tools-extra/docs/clang-rename.rst

28

Interesting, I thought we do the same logic in Clangd. Yeah, I think we should fix that behavior.

[ilya-biryukov]

clang-tools-extra/docs/clang-rename.rst

28

For that we would need up-to-date cross references

[kbobyrev]

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

[ilya-biryukov]

Leaving some comments, but also suggest getting the final LGTM from the owner of the doc (@ioeric?)

clang-tools-extra/docs/clang-rename.rst

141

handle renaming requests seems to assume some familiarity with LSP. Maybe rephrase?

167

Accidentally linked to clang-rename.py instead clang-rename.el?

[ioeric]

clang-tools-extra/docs/clang-rename.rst

140

nit: clangd *shares* the renaming infrastructure of clang-rename...

141

Currently it only supports renaming symbol within a single file, but in the future it will have much better support than the standalone tool.

This seems clangd specific and can easily get outdated when the support is actually added in clangd. Consider moving it to clangd's documentation if we do want to advertise rename at this point?

[kbobyrev]

• 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

[kbobyrev]

@ioeric does it look better now?

clang-tools-extra/docs/clang-rename.rst

 project. If you have any ideas or suggestions, you might want to put a feature
 request there.
 
 Using Clang-Rename
 ==================
 
 :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
 example of how to do this see `How To Setup Tooling For LLVM
 <http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html>`_). You can also
 specify compilation options on the command line after `--`:
 
 .. code-block:: console
 
   $ clang-rename -offset=42 -new-name=foo test.cpp -- -Imy_project/include -DMY_DEFINES ...
 
clang-rename common options:
     -input=<string>            - YAML file to load oldname-newname pairs from.
     -new-name=<string>         - The new name to change the symbol to.
     -offset=<uint>             - Locates the symbol by offset as opposed to <line>:<column>.
     -p=<string>                - Build path
     -pl                        - Print the locations affected by renaming to stderr.
     -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
 `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**.
 
 Once installed, you can point your cursor to symbols you want to rename, press
 `<leader>cr` and type new desired name. The `<leader> key
 <http://vim.wikia.com/wiki/Mapping_keys_in_Vim_-_Tutorial_(Part_3)#Map_leader>`_
 is a reference to a specific key defined by the mapleader variable and is bound
 to backslash by default.
 
 Emacs Integration
 =================
 
 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.el>`_.
 
 Once installed, you can point your cursor to symbols you want to rename, press
 `M-X`, type `clang-rename` and new desired name.
 
 Please note that **you have to save all buffers, in which the replacement will
 happen before running the tool**.

clang-tools-extra/docs/clangd.rst

 +-------------------------------------+------------+----------+
 | Hide Method                         | No         |   No     |
 +-------------------------------------+------------+----------+
 | Implement Method                    | No         |   No     |
 +-------------------------------------+------------+----------+
 | 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
 ==================
 
 A good place for interested contributors is the `Clangd developer mailing list
 <http://lists.llvm.org/mailman/listinfo/clangd-dev>`_. For discussions with the
 broader community on topics not only related to Clangd, use
 `Clang developer mailing list
 <http://lists.llvm.org/mailman/listinfo/cfe-dev>`_.
 If you're also interested in contributing patches to :program:`Clangd`, take a
 look at the `LLVM Developer Policy
 <http://llvm.org/docs/DeveloperPolicy.html>`_ and `Code Reviews
 <http://llvm.org/docs/Phabricator.html>`_ page. Contributions of new features
 to the `Language Server Protocol
 <https://github.com/Microsoft/language-server-protocol>`_ itself would also be
 very useful, so that :program:`Clangd` can eventually implement them in a
 conforming way.