This is an archive of the discontinued LLVM Phabricator instance.

Differential D101284

[docs] Update the llvm/example section
ClosedPublic

Authored by pooja2299 on Apr 26 2021, 4:42 AM.

Details

Reviewers
xgupta
fhahn
reames
Commits
rG0b9447157b01: [docs] Update the llvm/example section
Summary

Added details about the llvm/example section.

Diff Detail

Unit TestsFailed

TimeTest
760 msx64 windows > lld.MachO::reproduce.s

Event Timeline

pooja2299 requested review of this revision.Apr 26 2021, 4:42 AM
pooja2299 created this revision.
Herald added a project: Restricted Project. · View Herald TranscriptApr 26 2021, 4:42 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
Harbormaster completed remote builds in B100900: Diff 340481.Apr 26 2021, 5:16 AM
pooja2299 updated this revision to Diff 341251.Apr 28 2021, 9:53 AM

Improved llvm/example section

pooja2299 mentioned this in D101306: [docs]updated the llvm/example revision.Apr 28 2021, 10:22 AM
pooja2299 updated this revision to Diff 341260.Apr 28 2021, 10:33 AM

Removed ExceptionDemo and brainF topic

xgupta accepted this revision.Apr 28 2021, 10:51 AM
xgupta added subscribers: fhahn, reames.

LGTM, Thanks for the patch!

Also adding @fhahn and @reames as reviewers as it is an important doc of LLVM.

This revision is now accepted and ready to land.Apr 28 2021, 10:51 AM
xgupta added reviewers: fhahn, reames.Apr 28 2021, 10:51 AM
reames added a comment.Apr 28 2021, 11:52 AM

Minor optional suggestions, but LGTM to me too.

@xgupta - I suggest avoiding both LGTMing and asking for another reviewer. Given LLVM is a single accept culture, this can be really confusing to new contributors. I suggest wording along the lines of "This seems good to me, but I'd like a second opinion before LGTMing. Maybe X and Y can confirm?" Alternatively, you could simply LGTM if you were comfortable with that. Another phrasing might be "LGTM, but please wait N days before submitting in case X or Y have additional comments".

llvm/docs/GettingStarted.rst
820–834

The last part of this sentence gets a bit complicated, can I suggest:

Some simple examples showing how to use LLVM as a compiler for a custom language - including lowering, optimization, and code generation.

826

Maybe replace "both static and JIT" with " both static (ahead of time) and various approaches to Just In Time (JIT) compilation."

xgupta added a comment.Apr 28 2021, 12:40 PM
In D101284#2723554, @reames wrote:

Minor optional suggestions, but LGTM to me too.

@xgupta - I suggest avoiding both LGTMing and asking for another reviewer. Given LLVM is a single accept culture, this can be really confusing to new contributors. I suggest wording along the lines of "This seems good to me, but I'd like a second opinion before LGTMing. Maybe X and Y can confirm?" Alternatively, you could simply LGTM if you were comfortable with that. Another phrasing might be "LGTM, but please wait N days before submitting in case X or Y have additional comments".

Yes @reames, I agree, I will remember your suggestion from next time. I was just a little afraid that I am also not very experienced so giving only my acceptance to commit changes is a little risky(IMO). If next time I have confusion I only add an appropriate reviewer for that patch.

( Additional context here is that @pooja2299 is an Outreachy applicant and I am co-mentor for one project, so she adds me on every review so I will aware of her progress but I may not be the perfect reviewer for every patch)

Harbormaster completed remote builds in B101454: Diff 341251.Apr 28 2021, 1:00 PM
Harbormaster completed remote builds in B101461: Diff 341260.Apr 28 2021, 1:06 PM
pooja2299 updated this revision to Diff 341304.Apr 28 2021, 1:37 PM

Edited few lines as suggested in comments.

Harbormaster completed remote builds in B101491: Diff 341304.Apr 28 2021, 3:50 PM
pooja2299 added a comment.May 4 2021, 10:30 PM

@fhahn and @reames can you please review this patch?

reames added a comment.May 5 2021, 8:49 AM
In D101284#2738040, @pooja2299 wrote:

@fhahn and @reames can you please review this patch?

I have already given an LGTM, what more are you expecting?

pooja2299 added a comment.May 5 2021, 8:56 AM
In D101284#2739140, @reames wrote:
In D101284#2738040, @pooja2299 wrote:

@fhahn and @reames can you please review this patch?

I have already given an LGTM, what more are you expecting?

I meant after the changes that you asked .
Thanks a lot 😄 👍

This revision was landed with ongoing or failed builds.May 5 2021, 9:04 AM
Closed by commit rG0b9447157b01: [docs] Update the llvm/example section (authored by pooja2299, committed by xgupta). · Explain Why
This revision was automatically updated to reflect the committed changes.
xgupta added a commit: rG0b9447157b01: [docs] Update the llvm/example section.
reames added a comment.May 5 2021, 9:05 AM
In D101284#2739148, @pooja2299 wrote:
In D101284#2739140, @reames wrote:
In D101284#2738040, @pooja2299 wrote:

@fhahn and @reames can you please review this patch?

I have already given an LGTM, what more are you expecting?

I meant after the changes that you asked .
Thanks a lot 😄 👍

Ah, sorry, I'm so used to LLVM phrasing that I forgot "LGTM w/minor optional comments" isn't widely understood. For us, that generally means you can land with the changes made (if you decide to) without further review.

pooja2299 added a comment.May 5 2021, 9:43 AM
In D101284#2739176, @reames wrote:
In D101284#2739148, @pooja2299 wrote:
In D101284#2739140, @reames wrote:
In D101284#2738040, @pooja2299 wrote:

@fhahn and @reames can you please review this patch?

I have already given an LGTM, what more are you expecting?

I meant after the changes that you asked .
Thanks a lot 😄 👍

Ah, sorry, I'm so used to LLVM phrasing that I forgot "LGTM w/minor optional comments" isn't widely understood. For us, that generally means you can land with the changes made (if you decide to) without further review.

Oh ok 👍 I will remember this next time.

Revision Contents

PathSize
llvm/
docs/
16 lines

Diff 341304

llvm/docs/GettingStarted.rst

Show First 20 Lines • Show All 811 Lines • ▼ Show 20 Lines
One useful source of information about the LLVM source base is the LLVM `doxygen One useful source of information about the LLVM source base is the LLVM `doxygen
<http://www.doxygen.org/>`_ documentation available at <http://www.doxygen.org/>`_ documentation available at
`<https://llvm.org/doxygen/>`_. The following is a brief introduction to code `<https://llvm.org/doxygen/>`_. The following is a brief introduction to code
layout: layout:
``llvm/examples`` ``llvm/examples``
----------------- -----------------
Simple examples using the LLVM IR and JIT. - Some simple examples showing how to use LLVM as a compiler for a custom
language - including lowering, optimization, and code generation.
- Kaleidoscope Tutorial: Kaleidoscope language tutorial run through the
implementation of a nice little compiler for a non-trivial language
including a hand-written lexer, parser, AST, as well as code generation
support using LLVM- both static (ahead of time) and various approaches to
reamesUnsubmitted
Not Done
ReplyInline Actions

Maybe replace "both static and JIT" with " both static (ahead of time) and various approaches to Just In Time (JIT) compilation."

reames: Maybe replace "both static and JIT" with " both static (ahead of time) and various approaches…
Just In Time (JIT) compilation.
`Kaleidoscope Tutorial for complete beginner
<https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/index.html>`_.
- BuildingAJIT: Examples of the `BuildingAJIT tutorial
<https://llvm.org/docs/tutorial/BuildingAJIT1.html>`_ that shows how LLVM’s
ORC JIT APIs interact with other parts of LLVM. It also, teaches how to
recombine them to build a custom JIT that is suited to your use-case.
reamesUnsubmitted
Not Done
ReplyInline Actions

The last part of this sentence gets a bit complicated, can I suggest:

Some simple examples showing how to use LLVM as a compiler for a custom language - including lowering, optimization, and code generation.

reames: The last part of this sentence gets a bit complicated, can I suggest: Some simple examples…
``llvm/include`` ``llvm/include``
---------------- ----------------
Public header files exported from the LLVM library. The three main subdirectories: Public header files exported from the LLVM library. The three main subdirectories:
``llvm/include/llvm`` ``llvm/include/llvm``
▲ Show 20 Lines • Show All 370 Lines • Show Last 20 Lines