[PATCH] D72057: [docs] Update dead anchor in hacking page

Alexander Lanin via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Thu Jan 2 14:39:16 PST 2020


AlexanderLanin marked an inline comment as done.
AlexanderLanin added inline comments.


================
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>
 
----------------
aaron.ballman wrote:
> AlexanderLanin wrote:
> > aaron.ballman wrote:
> > > Should this instead point to `https://llvm.org/docs/GettingStarted.html#sending-patches` to more closely match the original target anchor?
> > For a precise match yes, but I figured that one would need to start with git first of all as git is not mentioned anywhere else on the page.
> That's fair, but I think this whole section needs a bit more love than what's proposed. You cannot use svn diff for creating patches within a git repo. This text only makes sense when we were still doing the transition from svn to git, and the bit you're changing is the "oh yeah, or you can use git if you want" stuff. Now we need it to read "This is how you do this with git", at which point the checkout from git link isn't as useful as pointing out how you send a patch (which is the next logical step after forming a patch file).
> 
> Would you like to take a stab at updating this section rather than just the link?
Actually it would make sense to remove the 'Creating Patch Files' section here as that's redundant to https://llvm.org/docs/GettingStarted.html. There is nothing clang specific here. We are talking about a monorepo after all.
While it may seem nice to have one single clang page which explains everything, it's not:
It doesn't cover the topics in sufficient depth, it's redundant to other pages and it's hard to keep it up to date as we see with svn usage.

It's the same with:
* https://llvm.org/docs/Contributing.html#how-to-submit-a-patch
* https://llvm.org/docs/GettingStarted.html#sending-patches
which seem to simply have diverged over time.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D72057





More information about the cfe-commits mailing list