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

Aaron Ballman via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Wed Jan 1 12:49:59 PST 2020


aaron.ballman accepted this revision.
aaron.ballman added a comment.
This revision is now accepted and ready to land.

As you mention, we're already inconsistent with how we designate where the repo lives on disk, so I'm fine with landing this as-is and making the root part of the path consistent in a follow-up. LGTM, with the "getting started" changes pulled out.



================
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!
----------------
AlexanderLanin wrote:
> 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.
A separate pull request to make them consistent would be a great follow-up to this one.


================
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>
 
----------------
AlexanderLanin wrote:
> Jim wrote:
> > This change should be in a separate patch.
> Ok, separate patch: https://reviews.llvm.org/D72057
Please be sure to back this change out before landing this patch.


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

https://reviews.llvm.org/D71982





More information about the cfe-commits mailing list