[PATCH] D71982: [docs] Update path to clang-tools-extra

Alexander Lanin via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Wed Jan 1 11:00:23 PST 2020


AlexanderLanin marked 3 inline comments as done.
AlexanderLanin added inline comments.


================
Comment at: clang-tools-extra/docs/clang-tidy/Contributing.rst:66
 
-Once you are done, change to the ``llvm/tools/clang/tools/extra`` directory, and
+Once you are done, change to the ``llvm/clang-tools-extra`` directory, and
 let's start!
----------------
aaron.ballman wrote:
> Jim wrote:
> > I am no sure that "llvm/clang-tools-extra" should be replaced as "llvm-project/clang-tools-extra".
> > Maybe someone would confuse with "llvm", "llvm-project" and "llvm-project/llvm"
> Elsewhere we use `path/to/llvm/source`, which seems to be sufficiently clear.
While this goes slightly beyond the scope of the original pull request I tend to agree as `llvm` can easily be confused with `llvm-project/llvm` as Jim wrote.
However I'm not clear on the exact target: looking through other docs probably most often you'll find `path/to/llvm/source` as Aaron mentioned, but other times it's `/path/to/llvm-project/`, `llvm-project/`, `~/llvm/`, `~/clang-llvm/`, `/path/to/llvm`, `/path/to/llvm/src`, `/path/to/llvm/sources` or `/path/to/llvm/tree`.

While this is not that important, it's difficult enough to get started with anything inside llvm as it is. This is low hanging fruit. I would create a separate pull request afterwards to align those.


================
Comment at: clang/www/hacking.html:301
 
-  <p>It is also possible to <a href="https://llvm.org/docs/GettingStarted.html#sending-patches-with-git">use git to contribute</a> to Clang.</p>
+  <p>It is also possible to <a href="https://llvm.org/docs/GettingStarted.html#checkout-llvm-from-git">use git to contribute</a> to Clang.</p>
 
----------------
Jim wrote:
> This change should be in a separate patch.
Ok, separate patch: https://reviews.llvm.org/D72057


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D71982/new/

https://reviews.llvm.org/D71982





More information about the cfe-commits mailing list