[llvm] 932a618 - [llvm/docs] Fix whitespace and column limit in llvm-mc.rst

Fri Sep 1 13:20:45 PDT 2023

Author: Jonas Devlieghere
Date: 2023-09-01T13:20:39-07:00
New Revision: 932a6187b49e3ac6db8797f72b295728d4569917

URL: https://github.com/llvm/llvm-project/commit/932a6187b49e3ac6db8797f72b295728d4569917
DIFF: https://github.com/llvm/llvm-project/commit/932a6187b49e3ac6db8797f72b295728d4569917.diff

LOG: [llvm/docs] Fix whitespace and column limit in llvm-mc.rst

 - Remove trailing whitespace.
 - Honor 80 cols.
 - Reflow text.

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 db25ca49e8d48c..ea1fbf482550de 100644

--- a/llvm/docs/CommandGuide/llvm-mc.rst
+++ b/llvm/docs/CommandGuide/llvm-mc.rst
@@ -11,13 +11,13 @@ SYNOPSIS
 DESCRIPTION
 -----------
 
-The :program:`llvm-mc` command take input as the assembly code for a 
-specified architecture and generate object file or executable as a output 
-for a specified architecture. 
+The :program:`llvm-mc` command take input as the assembly code for a specified
+architecture and generate object file or executable as a output for a specified
+architecture.
 
-:program:`llvm-mc` provide powerful set of the tool for working with the machine code such 
-as encoding of their instruction and their internal representation, disassemble
-string to bytes etc. 
+:program:`llvm-mc` provide powerful set of the tool for working with the
+machine code such as encoding of their instruction and their internal
+representation, disassemble string to bytes etc.
 
 The choice of architecture for the output assembly code is automatically
 determined from the input file, unless the :option:`--arch` option is used to
@@ -26,13 +26,15 @@ override the default.
 OPTIONS
 -------
 
-If the :option:`-o` option is omitted, then :program:`llvm-mc` will send its output
-to standard output if the input is from standard input.  If the :option:`-o`
-option specifies "``-``", then the output will also be sent to standard output.
+If the :option:`-o` option is omitted, then :program:`llvm-mc` will send its
+output to standard output if the input is from standard input.  If the
+:option:`-o` option specifies "``-``", then the output will also be sent to
+standard output.
 
 If no :option:`-o` option is specified and an input file other than "``-``" is
-specified, then :program:`llvm-mc` creates the output filename by taking the input
-filename, removing any existing ``.s`` extension, and adding a ``.o`` suffix.
+specified, then :program:`llvm-mc` creates the output filename by taking the
+input filename, removing any existing ``.s`` extension, and adding a ``.o``
+suffix.
 
 Other :program:`llvm-mc` options are described below.
 
@@ -50,27 +52,28 @@ End-user Options
 
 .. option:: --arch=<string>
 
- Target arch to assemble for, see -version for available targets. 
+ Target arch to assemble for, see -version for available targets.
 
 .. option:: --as-lex
 
- Apply the assemblers "lexer" to break the input into tokens and print each of them out. 
- This is intended to help develop and test an assembler implementation.
+ Apply the assemblers "lexer" to break the input into tokens and print each of
+ them out. This is intended to help develop and test an assembler
+ implementation.
 
 .. option:: --assemble
 
- Assemble assembly file (default), and print the result to assembly. 
- This is useful to design and test instruction parsers, and can be a useful tool when combined with other llvm-mc flags. 
- For example, this option may be useful to transcode assembly from 
diff erent dialects, e.g. on Intel where you can use 
- -output-asm-variant=1 to translate from AT&T to Intel assembly syntax. 
- It can also be combined with --show-encoding to understand how instructions are encoded.
+ Assemble assembly file (default), and print the result to assembly. This is
+ useful to design and test instruction parsers, and can be a useful tool when
+ combined with other llvm-mc flags. For example, this option may be useful to
+ transcode assembly from 
diff erent dialects, e.g. on Intel where you can use
+ -output-asm-variant=1 to translate from AT&T to Intel assembly syntax. It can
+ also be combined with --show-encoding to understand how instructions are
+ encoded.
 
 .. option:: --disassemble
 
  Parse a series of hex bytes, and print the result out as assembly syntax.
 
-
-
 .. option:: --mdis
 
  Marked up disassembly of string of hex bytes.
@@ -81,10 +84,10 @@ End-user Options
 
 .. 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`.
+ 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
 
@@ -94,32 +97,32 @@ End-user Options
 
  Create CFI directives that assume the code might be more than 2 GB.
 
-.. option:: --main-file-name=<string>  
-    
+.. option:: --main-file-name=<string>
+
  Specify the name we should consider the input file.
 
- 
+
 .. option:: --masm-hexfloats
-    
+
  Enable MASM-style hex float initializers (3F800000r).
 
 
 .. option:: -mattr=a1,+a2,-a3,...
  Target specific attributes (-mattr=help for details).
 
-.. option:: --mcpu=<cpu-name> 
+.. option:: --mcpu=<cpu-name>
 
  Target a specific cpu type (-mcpu=help for details).
 
-.. option::   --triple=<string>  
+.. option::   --triple=<string>
 
  Target triple to assemble for, see -version for available targets.
 
-.. option::  --split-dwarf-file=<filename> 
+.. option::  --split-dwarf-file=<filename>
 
  DWO output filename.
 
-.. option:: --show-inst-operands 
+.. option:: --show-inst-operands
 
  Show instructions operands as parsed.
 
@@ -127,31 +130,31 @@ End-user Options
 
  Show internal instruction representation.
 
-.. option::  --show-encoding   
+.. option::  --show-encoding
 
  Show instruction encodings.
 
-.. option:: --save-temp-labels   
+.. option:: --save-temp-labels
 
  Don't discard temporary labels.
 
-.. option::   --relax-relocations  
+.. option::   --relax-relocations
 
  Emit R_X86_64_GOTPCRELX instead of R_X86_64_GOTPCREL.
 
-.. option:: --print-imm-hex      
+.. option:: --print-imm-hex
 
  Prefer hex format for immediate values.
 
-.. option::  --preserve-comments 
+.. option::  --preserve-comments
 
  Preserve Comments in outputted assembly.
 
 .. option:: --output-asm-variant=<uint>
 
  Syntax variant to use for output printing. For example, on x86 targets
- --output-asm-variant=0 prints in AT&T syntax, and --output-asm-variant=1 prints
- in Intel/MASM syntax.
+ --output-asm-variant=0 prints in AT&T syntax, and --output-asm-variant=1
+ prints in Intel/MASM syntax.
 
 .. option:: --compress-debug-sections=[none|zlib|zstd]
 


        
