@@ -11,13 +11,13 @@ SYNOPSIS
1111DESCRIPTION
1212-----------
1313
14- The :program: `llvm-mc ` command take input as the assembly code for a
15- specified architecture and generate object file or executable as a output
16- for a specified architecture.
14+ The :program: `llvm-mc ` command take input as the assembly code for a specified
15+ architecture and generate object file or executable as a output for a specified
16+ architecture.
1717
18- :program: `llvm-mc ` provide powerful set of the tool for working with the machine code such
19- as encoding of their instruction and their internal representation, disassemble
20- string to bytes etc.
18+ :program: `llvm-mc ` provide powerful set of the tool for working with the
19+ machine code such as encoding of their instruction and their internal
20+ representation, disassemble string to bytes etc.
2121
2222The choice of architecture for the output assembly code is automatically
2323determined from the input file, unless the :option: `--arch ` option is used to
@@ -26,13 +26,15 @@ override the default.
2626OPTIONS
2727-------
2828
29- If the :option: `-o ` option is omitted, then :program: `llvm-mc ` will send its output
30- to standard output if the input is from standard input. If the :option: `-o `
31- option specifies "``- ``", then the output will also be sent to standard output.
29+ If the :option: `-o ` option is omitted, then :program: `llvm-mc ` will send its
30+ output to standard output if the input is from standard input. If the
31+ :option: `-o ` option specifies "``- ``", then the output will also be sent to
32+ standard output.
3233
3334If no :option: `-o ` option is specified and an input file other than "``- ``" is
34- specified, then :program: `llvm-mc ` creates the output filename by taking the input
35- filename, removing any existing ``.s `` extension, and adding a ``.o `` suffix.
35+ specified, then :program: `llvm-mc ` creates the output filename by taking the
36+ input filename, removing any existing ``.s `` extension, and adding a ``.o ``
37+ suffix.
3638
3739Other :program: `llvm-mc ` options are described below.
3840
@@ -50,27 +52,28 @@ End-user Options
5052
5153.. option :: --arch= <string >
5254
53- Target arch to assemble for, see -version for available targets.
55+ Target arch to assemble for, see -version for available targets.
5456
5557.. option :: --as-lex
5658
57- Apply the assemblers "lexer" to break the input into tokens and print each of them out.
58- This is intended to help develop and test an assembler implementation.
59+ Apply the assemblers "lexer" to break the input into tokens and print each of
60+ them out. This is intended to help develop and test an assembler
61+ implementation.
5962
6063.. option :: --assemble
6164
62- Assemble assembly file (default), and print the result to assembly.
63- This is useful to design and test instruction parsers, and can be a useful tool when combined with other llvm-mc flags.
64- For example, this option may be useful to transcode assembly from different dialects, e.g. on Intel where you can use
65- -output-asm-variant=1 to translate from AT&T to Intel assembly syntax.
66- It can also be combined with --show-encoding to understand how instructions are encoded.
65+ Assemble assembly file (default), and print the result to assembly. This is
66+ useful to design and test instruction parsers, and can be a useful tool when
67+ combined with other llvm-mc flags. For example, this option may be useful to
68+ transcode assembly from different dialects, e.g. on Intel where you can use
69+ -output-asm-variant=1 to translate from AT&T to Intel assembly syntax. It can
70+ also be combined with --show-encoding to understand how instructions are
71+ encoded.
6772
6873.. option :: --disassemble
6974
7075 Parse a series of hex bytes, and print the result out as assembly syntax.
7176
72-
73-
7477.. option :: --mdis
7578
7679 Marked up disassembly of string of hex bytes.
@@ -81,10 +84,10 @@ End-user Options
8184
8285.. option :: --filetype=[asm ,null ,obj]
8386
84- Sets the output filetype. Setting this flag to `asm ` will make the tool
85- output text assembly. Setting this flag to `obj ` will make the tool output
86- an object file. Setting it to `null ` causes no output to be created and can be
87- used for timing purposes. The default value is `asm `.
87+ Sets the output filetype. Setting this flag to `asm ` will make the tool output
88+ text assembly. Setting this flag to `obj ` will make the tool output an object
89+ file. Setting it to `null ` causes no output to be created and can be used for
90+ timing purposes. The default value is `asm `.
8891
8992.. option :: -g
9093
@@ -94,64 +97,64 @@ End-user Options
9497
9598 Create CFI directives that assume the code might be more than 2 GB.
9699
97- .. option :: --main-file-name= <string >
98-
100+ .. option :: --main-file-name= <string >
101+
99102 Specify the name we should consider the input file.
100103
101-
104+
102105.. option :: --masm-hexfloats
103-
106+
104107 Enable MASM-style hex float initializers (3F800000r).
105108
106109
107110.. option :: -mattr=a1 ,+a2 ,-a3 ,...
108111 Target specific attributes (-mattr=help for details).
109112
110- .. option :: --mcpu= <cpu-name >
113+ .. option :: --mcpu= <cpu-name >
111114
112115 Target a specific cpu type (-mcpu=help for details).
113116
114- .. option :: --triple= <string >
117+ .. option :: --triple= <string >
115118
116119 Target triple to assemble for, see -version for available targets.
117120
118- .. option :: --split-dwarf-file= <filename >
121+ .. option :: --split-dwarf-file= <filename >
119122
120123 DWO output filename.
121124
122- .. option :: --show-inst-operands
125+ .. option :: --show-inst-operands
123126
124127 Show instructions operands as parsed.
125128
126129.. option :: --show-inst
127130
128131 Show internal instruction representation.
129132
130- .. option :: --show-encoding
133+ .. option :: --show-encoding
131134
132135 Show instruction encodings.
133136
134- .. option :: --save-temp-labels
137+ .. option :: --save-temp-labels
135138
136139 Don't discard temporary labels.
137140
138- .. option :: --relax-relocations
141+ .. option :: --relax-relocations
139142
140143 Emit R_X86_64_GOTPCRELX instead of R_X86_64_GOTPCREL.
141144
142- .. option :: --print-imm-hex
145+ .. option :: --print-imm-hex
143146
144147 Prefer hex format for immediate values.
145148
146- .. option :: --preserve-comments
149+ .. option :: --preserve-comments
147150
148151 Preserve Comments in outputted assembly.
149152
150153.. option :: --output-asm-variant= <uint >
151154
152155 Syntax variant to use for output printing. For example, on x86 targets
153- --output-asm-variant=0 prints in AT&T syntax, and --output-asm-variant=1 prints
154- in Intel/MASM syntax.
156+ --output-asm-variant=0 prints in AT&T syntax, and --output-asm-variant=1
157+ prints in Intel/MASM syntax.
155158
156159.. option :: --compress-debug-sections=[none|zlib|zstd]
157160
0 commit comments