The patch files section is 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 the svn instructions.
Details
- Reviewers
aaron.ballman
Diff Detail
Event Timeline
clang/www/hacking.html | ||
---|---|---|
278–279 | Should this instead point to https://llvm.org/docs/GettingStarted.html#sending-patches to more closely match the original target anchor? |
clang/www/hacking.html | ||
---|---|---|
278–279 | 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. |
clang/www/hacking.html | ||
---|---|---|
278–279 | 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? |
clang/www/hacking.html | ||
---|---|---|
278–279 | 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. It's the same with:
which seem to simply have diverged over time. |
Not sure we can call this updated proposal 'love': it's definitely not the goal to have less documentation, just less redundancy.
I'll remove redundancies between those two in a separate pull request:
LGTM with a small typo fix. Do you need someone to commit this on your behalf?
clang/www/hacking.html | ||
---|---|---|
279 | Getting started -> Getting Started (or, alternatively, getting started) |
Thank you for the patch! I've commit on your behalf in e5a56f2d50ce1939eba4fddbeb9c8e032db4fc95
Should this instead point to https://llvm.org/docs/GettingStarted.html#sending-patches to more closely match the original target anchor?