[llvm] 7bda9ff - [Docs][llvm-mc] Add documentation on --filetype flag

[Aiden Grossman via llvm-commits]

Author: Aiden Grossman
Date: 2023-03-25T17:44:27Z
New Revision: 7bda9ffb9cf021a256beac64de46bbd99203eaf9

URL: https://github.com/llvm/llvm-project/commit/7bda9ffb9cf021a256beac64de46bbd99203eaf9
DIFF: https://github.com/llvm/llvm-project/commit/7bda9ffb9cf021a256beac64de46bbd99203eaf9.diff

LOG: [Docs][llvm-mc] Add documentation on --filetype flag

Currently the filetype flag is not documented, and knowing the behavior
of this flag is fairly important for doing anything other than
disassembling to text assembly.

Reviewed By: lattner

Differential Revision: https://reviews.llvm.org/D146878

Added: 
    

Modified: 
    llvm/docs/CommandGuide/llvm-mc.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CommandGuide/llvm-mc.rst b/llvm/docs/CommandGuide/llvm-mc.rst
index b7a40a19c67fa..378b6638bf812 100644
--- a/llvm/docs/CommandGuide/llvm-mc.rst
+++ b/llvm/docs/CommandGuide/llvm-mc.rst
@@ -75,6 +75,13 @@ End-user Options
 
  Marked up disassembly of string of hex bytes.
 
+.. option:: --filetype=[asm,null,obj]
+
+ Sets the output filetype. Setting this flag to `asm` will make the tool
+ output text assembly. Setting this flag to `obj` will make the tool output
+ an object file. Setting it to `null` causes no output to be created and can be
+ used for timing purposes. The default value is `asm`.
+
 .. option:: -g
 
  Generate DWARF debugging info for assembly source files.