This is an archive of the discontinued LLVM Phabricator instance.

[docs] Remove outdated svn/git information from hacking page
ClosedPublic

Authored by AlexanderLanin on Jan 1 2020, 10:58 AM.

Details

Reviewers
aaron.ballman
Summary

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.

Diff Detail

Event Timeline

AlexanderLanin created this revision.Jan 1 2020, 10:58 AM
aaron.ballman added inline comments.Jan 1 2020, 12:40 PM
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?

AlexanderLanin marked an inline comment as done.Jan 1 2020, 1:24 PM
AlexanderLanin added inline comments.
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.

Jim added a subscriber: Jim.Jan 1 2020, 5:29 PM
aaron.ballman added inline comments.Jan 2 2020, 9:57 AM
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?

AlexanderLanin marked an inline comment as done.Jan 2 2020, 2:38 PM
AlexanderLanin added inline comments.
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.
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:

which seem to simply have diverged over time.

AlexanderLanin retitled this revision from [docs] Update dead anchor in hacking page to [docs] Remove outdated svn/git information from hacking page.
AlexanderLanin edited the summary of this revision. (Show Details)

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:

aaron.ballman accepted this revision.Jan 3 2020, 7:30 AM

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)

This revision is now accepted and ready to land.Jan 3 2020, 7:30 AM
AlexanderLanin marked an inline comment as done.

Getting Started since it's Getting Started with the LLVM System

LGTM with a small typo fix. Do you need someone to commit this on your behalf?

Yes, please. I cannot commit myself.
Alexander Lanin <alex@lanin.de>

aaron.ballman closed this revision.Jan 3 2020, 11:14 AM

Thank you for the patch! I've commit on your behalf in e5a56f2d50ce1939eba4fddbeb9c8e032db4fc95