This is an archive of the discontinued LLVM Phabricator instance.

[NFC] Suggest Release mode in clang GettingStarted.html
ClosedPublic

Authored by xgupta on Jun 10 2022, 6:20 AM.

Details

Summary

This fix https://github.com/llvm/llvm-project/issues/23841.
Lots of beginners are not of aware of this option do suggesting it here
would be helpful.

Diff Detail

Event Timeline

xgupta created this revision.Jun 10 2022, 6:20 AM
Herald added a project: Restricted Project. · View Herald TranscriptJun 10 2022, 6:20 AM
xgupta requested review of this revision.Jun 10 2022, 6:20 AM
Herald added a project: Restricted Project. · View Herald TranscriptJun 10 2022, 6:20 AM
Herald added a subscriber: cfe-commits. · View Herald Transcript
thieta requested changes to this revision.Jun 10 2022, 7:21 AM

Thanks for fixing - but it's not completely accurate right now.

clang/www/get_started.html
72

This isn't correct - invoking cmake without a CMAKE_BUILD_TYPE argument will just print an error. I would fix the command line below to include -DCMAKE_BUILD_TYPE=Release and have a comment saying switch Release to Debug if you need a debug build.

This revision now requires changes to proceed.Jun 10 2022, 7:21 AM
aaron.ballman added inline comments.Jun 10 2022, 7:29 AM
clang/www/get_started.html
72

+1 to most of this, but I'd have the comment say something along the lines of "See https://llvm.org/docs/CMake.html#frequently-used-cmake-variables for more options".

xgupta updated this revision to Diff 435947.Jun 10 2022, 9:25 AM

Address comments

xgupta marked 2 inline comments as done.Jun 10 2022, 9:25 AM
xgupta added inline comments.Jun 10 2022, 9:28 AM
clang/www/get_started.html
72

I hope 'most of this' also includes making changes to the default suggestion of -DCMAKE_BUILD_TYPE :)

Looks pretty close, just some minor nits from me.

clang/www/get_started.html
72

I hope 'most of this' also includes making changes to the default suggestion of -DCMAKE_BUILD_TYPE :)

Heh, it did! :-)

72–75
xgupta updated this revision to Diff 435957.Jun 10 2022, 9:47 AM
aaron.ballman accepted this revision.Jun 10 2022, 9:50 AM

LGTM aside from a missing comma (that can be fixed when landing). But you should give @thieta a chance to chime in before landing.

clang/www/get_started.html
72–77

Looks like this was missed with the other changes.

thieta accepted this revision.Jun 10 2022, 10:19 AM

Looks fine to me. Thanks for fixing!

This revision is now accepted and ready to land.Jun 10 2022, 10:19 AM
xgupta closed this revision.Jun 10 2022, 10:35 AM