[Docs] Updated the content of getting started documentation under llvm/lib/MC

[pooja2299]

Summary

Wrote about llvm/lib/MC subproject on https://llvm.org/docs/GettingStarted.html page.

[pooja2299]

Updated changes in GettingStarted.rst

[xgupta]

LGTM, Thanks for the patch.

[xgupta]

I added @arsenm as the second reviewer, If he thinks the patch looks good, we will commit it.

[arsenm]

llvm/docs/GettingStarted.rst

887

Saying it translates implies it’s just the assembler and disassembler. It normally directly emits object files

[pooja2299]

Changed the statement that said 'translation of machine instruction, which suggested that it is just assembler or disassembler.

[pooja2299]

updated llvm/lib/MC section

[pooja2299]

@arsenm Plse review it now.

[arsenm]

llvm/docs/GettingStarted.rst

887–888

object and text?

[pooja2299]

I didn't understand, can u elaborate plse @arsenm . Does it produce text file as well? it helps in object code emission?

[arsenm]

In D101047#2712791, @pooja2299 wrote:

I didn't understand, can u elaborate plse @arsenm . Does it produce text file as well? it helps in object code emission?

It does both. It's everything related to the presentation and consumption of machine encoding, text and binary

[pooja2299]

In D101047#2712826, @arsenm wrote:

In D101047#2712791, @pooja2299 wrote:

I didn't understand, can u elaborate plse @arsenm . Does it produce text file as well? it helps in object code emission?

It does both. It's everything related to the presentation and consumption of machine encoding, text and binary

ok i will update this

[pooja2299]

some more changes to MC section

[pooja2299]

redited lib/MC section

[pooja2299]

@arsenm Can u please review the patch again and give your feedback?

[xgupta]

Assuming all comment addresses I will commit this patch on your behalf @pooja2299.

[arsenm]

llvm/docs/GettingStarted.rst

887

"It produces machine code object file" sounds grammatically off. files? This also stopped referencing the text assembly emission

[pooja2299]

Updated changes.

[pooja2299]

@arsenm should I change something else or is it fine?

[xgupta]

I think you can copy-paste from here https://llvm.org/docs/CodeGenerator.html#the-mc-layer.

Read a little about this layer under MCInst section here: https://eli.thegreenplace.net/2012/11/24/life-of-an-instruction-in-llvm
MC layer handles the object-file emission (it can also emit textual assembly files).

[xgupta]

I am really not an idol reviewer for this patch.

[pooja2299]

Updated with the suggested changes.

llvm/docs/GettingStarted.rst

 
 ``llvm/lib/MC/``
 
-  (FIXME: T.B.D.)  ....?
+  Libraries that represent and processs code at machine code level. It translates machine instructions between textual forms and machine code.
+  Handles things like label names, machine instructions, and sections in the object file.
 
 ``llvm/lib/ExecutionEngine/``